Skip to content

Improve Onboarding with Generated System Diagrams #3664

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

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.

@petyaslavova
Copy link
Collaborator

Hi @ivanmilevtues, thank you for your contribution! We'll have a look at it shortly.

@ivanmilevtues
Copy link
Author

I guess it is probably easier to review the change if you see the diagrams rendered. You can do that here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/redis-py/on_boarding.md

I got few questions, on how to keep these docs up-to-date and wanted to share that we are wroking on github action which will allow you to update it automatically depending on your liking (merge in main/release etc.)

@ivanmilevtues
Copy link
Author

Hey @petyaslavova,
We did major improvements on our diagram generation engine. I regerated the diagrams for this PR.
You can see how they render again here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/redis-py/on_boarding.md (it is the same link as before).

Happy to connect and discuss if this can be integrated, as we now also have a github action which will keep the diagrams up-to-date with new commits/PR's or other heuristic.

Let me know!

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

Successfully merging this pull request may close these issues.

2 participants