Visualization docs for the localstack's codebase #12770
Conversation
There was a problem hiding this comment.
Welcome to LocalStack! Thanks for raising your first Pull Request and landing in your contributions. Our team will reach out with any reviews or feedbacks that we have shortly. We recommend joining our Slack Community and share your PR on the #community channel to share your contributions with us. Please make sure you are following our contributing guidelines and our Code of Conduct.
|
I have read the CLA Document and I hereby sign the CLA imilev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. |
semver: patch
Hi! This PR adds high-level diagrams of the localstack codebase to help new contributors quickly get oriented.
You can see how it all renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/localstack/on_boarding.md
Motivation
The idea is to make onboarding easier—especially for open-source contributors who typically want to work on a specific module. Visualizing the codebase helps people understand how things fit together without needing to read everything up front.
I’d love to hear how you currently onboard new contributors—do you think something like this could help?
Feedback is very welcome.
(Discussions aren't enabled on this repo, so I’m opening a PR instead.)
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.
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.
Changes
All the added files are rendered in markdown as you can see here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/localstack/on_boarding.md