asyncapi
[📑 Docs]: Improve Development.md onboarding guide for new contributors
Hello! As a new contributor, I was setting up the project locally using the Development.md guide. While the guide is comprehensive, I realized that a brief overview of the monorepo structure could help future contributors understand the project faster.
I noticed that the Turborepo folder structure is already documented, but I think a small section in Development.md summarizing it, along with pointers on scripts and workflows, would make the onboarding experience smoother.
Proposed Enhancement
- Add a short summary of the monorepo packages (generator, hooks, react-sdk, nunjucks-filters, keeper, components, helpers, templates) for context.
- Mention that Turborepo orchestrates builds, tests, and scripts.
- Highlight root-level npm scripts and how they can target individual packages (e.g.,
generator:test:unit,nunjucks-filters:test). - Suggest using
npm run devfor watch mode during development. - Link to the Turborepo docs for contributors who want to dive deeper.
Expected Outcome
- Faster onboarding for new contributors.
- Fewer questions about running scripts or understanding package relationships.
- A clearer understanding of the project’s architecture from the start.
Code of Conduct
- [x] I agree to follow this project's Code of Conduct
Are you willing to work on this issue?
Yes, I am willing to submit a PR for this improvement.
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Yes @varshitha-besthu, the structure is mentioned in README.md. I think it makes sense to include it in Development.md as well, so anyone setting up the project locally can get all necessary info in one place. But if that seems repetitive, I can skip it and just focus on clarifying scripts, watch mode, and the other updates I suggested. What do you think ?
