Current Documentation Issue
While reviewing the rendered version of QUICKSTART.md, I noticed that it contains sections such as "Complete QUICKSTART.md Code" and "What to replace in README.md".
These sections appear to be authoring or template-generation instructions rather than contributor-facing onboarding content. Since they are visible in the rendered documentation, they may cause confusion for first-time contributors who are following the guide to make their first contribution.
Suggested Improvement
Consider removing or relocating template-generation content that is not intended for contributors and keeping QUICKSTART.md focused on onboarding and contribution instructions.
This would improve readability and provide a clearer experience for beginners following the guide.
Additional Context
I observed this directly in the rendered GitHub view of QUICKSTART.md while reviewing the onboarding documentation. The sections mentioned above are currently visible as part of the contributor guide.
Current Documentation Issue
While reviewing the rendered version of QUICKSTART.md, I noticed that it contains sections such as "Complete QUICKSTART.md Code" and "What to replace in README.md".
These sections appear to be authoring or template-generation instructions rather than contributor-facing onboarding content. Since they are visible in the rendered documentation, they may cause confusion for first-time contributors who are following the guide to make their first contribution.
Suggested Improvement
Consider removing or relocating template-generation content that is not intended for contributors and keeping QUICKSTART.md focused on onboarding and contribution instructions.
This would improve readability and provide a clearer experience for beginners following the guide.
Additional Context
I observed this directly in the rendered GitHub view of QUICKSTART.md while reviewing the onboarding documentation. The sections mentioned above are currently visible as part of the contributor guide.