Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md - add a link to repository map #490

Merged
merged 2 commits into from
Aug 17, 2023

Conversation

alexkarezin
Copy link
Contributor

Describe your changes

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/quarkiversequarkusquinoa/).

Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project.

In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.

Fixes Issue

Documentation-only change

Check List (Check all the applicable boxes)

  • My code follows the code style of this project.
  • My change requires changes to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed.

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/quarkiversequarkusquinoa/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project.

In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.
@melloware
Copy link
Contributor

Nice let me check it out. If I like it I will add it to some other extensions I manage

@melloware
Copy link
Contributor

Just testing it looks like your shield doesn't support ?style=for-the-badge ??

https://sourcespy.com/shield.svg?style=for-the-badge

@alexkarezin
Copy link
Contributor Author

Thanks for looking into it!

Just testing it looks like your shield doesn't support ?style=for-the-badge ??

Correct - it does not. Is it a requirement?

@melloware
Copy link
Contributor

Well on some of my other projects I like that style like this: https://github.com/open-sce/fluent-cli

@alexkarezin
Copy link
Contributor Author

Oh, I see! Would it be better I refer directly to shields.io? Like this:
https://img.shields.io/badge/SourceSpy-Project_Map-blue.svg?style=for-the-badge

@melloware
Copy link
Contributor

yes that would be great! so for this PR don't use ?style-for-the-badge but yeah I like the direct shields.io URL!

@shivarm shivarm added the documentation Improvements or additions to documentation label Aug 17, 2023
@shivarm shivarm requested a review from melloware August 17, 2023 01:44
@melloware melloware merged commit 03fbc92 into quarkiverse:main Aug 17, 2023
@melloware
Copy link
Contributor

@all-contributors add @alexkarezin for docs

@allcontributors
Copy link
Contributor

@melloware

I've put up a pull request to add @alexkarezin! 🎉

@alexkarezin
Copy link
Contributor Author

yes that would be great! so for this PR don't use ?style-for-the-badge but yeah I like the direct shields.io URL!

Thank you for merging and adding me in!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants