Skip to content

Conversation

@ivanmilevtues
Copy link

Hi! This PR adds high-level diagrams of the amazing_qr codebase to help new contributors get up-to-speed.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/amazing-qr/on_boarding.md

The diagrams are designed to give high-level understanding of the full codebase, allowing new contributors to focus on one component at the begining, knowing how it fits with-in the big picutre. Considering that there are mroe than 1.6K stars, the number of contributors/people interested in the codebase itself is substantial, would love to hear if you think such docs can help!

We’ve also released a free GitHub Action that keeps the diagrams automatically updated as the code changes, so there's no ongoing maintenance burden.

Any feedback is more than welcome!

I'd usually open a discussion first, but you don't have them enabled for this repo so I decided to go ahead and open a PR.

Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.

@cys138138
Copy link

cys138138 commented Jun 18, 2025 via email

@zhangtinghai
Copy link

zhangtinghai commented Jun 18, 2025 via email

@kuaij
Copy link

kuaij commented Jun 18, 2025 via email

@ivanmilevtues
Copy link
Author

Hey all, letting you know we are Open-Source now: https://github.com/CodeBoarding/CodeBoarding

@cys138138
Copy link

cys138138 commented Aug 2, 2025 via email

@kuaij
Copy link

kuaij commented Aug 2, 2025 via email

@zhangtinghai
Copy link

zhangtinghai commented Aug 2, 2025 via email

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.

4 participants