I have generated diagrams to help new people with haystack #9564
ivanmilevtues
started this conversation in
Show and tell
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.
-
I generated diagram representation of the haystack codebase: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/haystack/on_boarding.md
The idea is that the diagram helps new contributors by giving an overview of the codebase with it's main components. If you click on any of the components you see the same thing for the component itself!
Let me know what your opinion on diagram first documentation is!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people. Also as many people brought that the diagrams will become outdated fast, we've introduced free github action!
Beta Was this translation helpful? Give feedback.
All reactions