[Feature Request]: Add diagrams from CodeBoarding #1404
brovatten
started this conversation in
Feature requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
What needs to be done?
Adds visual and concise documentation of the entire repo
What problem does this solve?
Hard for new contributors/users to onboard onto the project due to its size
Target users/beneficiaries
New contributors
Current alternatives/workarounds
Reading the code/static diagrams
Proposed approach
Open a PR with .md files containing the generated diagrams. This provides linkage between the files themselves and relevant code references. I could integrate it either into a
.codeboardingfolder into the root or into the docs folder.Here's the diagram I generated:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/crawl4ai/on_boarding.md
Beta Was this translation helpful? Give feedback.
All reactions