Improve Onboarding with Generated System Diagrams #2356
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you @ivanmilevtues ! We will discuss |
|
Thanks but we are not going to merge this because it adds little value and too much maintenance cost. People who want AI content like this should just ask an AI model directly. |
|
Thank you for the answers @aclark4life and @ShaneHarvey! Just to touch on the maintainance point, we've just added a GitHub action which is free for public repos and it will maintain the documents automatically! Further the way we generate this is based on Static Analysis and LLMs. BUt I understand your point. Wish you all the best! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds auto-generated high-level diagrams and component-level documentation using CodeBoarding, aimed at improving developer onboarding by making it easier to get to know the codebase and lowering the barrier to contribution.
We would love to hear what you think about the generated diagrams — feedback is more than welcome. If you are interested in using CodeBoarding for other projects or want to get in touch, feel free to reach out to me.