Repository navigation
Documentation index and map #589
Description
Write docs/README.md: a single index of every document in the repository, grouped by audience — new contributor, backend developer, frontend developer, contract developer, operator, security reviewer — with a one-line description of each. Documentation is currently spread across docs/, docs/security/, docs/adr/, and four per-app docs/ directories with no entry point.
Acceptance criteria:
- Every
.mdin the repo (excluding generated output and dependency directories) is listed exactly once with a one-line description - Grouped by reader intent, not by directory, so someone can find the right document without knowing the layout
- Includes a short "start here" path for a first-time contributor, ending at
CONTRIBUTING.md - Cross-linked from
README.md, and the issue notes that this index must be updated whenever a document is added
Activity
zainmatty22 commentedon Aug 27, 2026
@zainmatty22 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @zainmatty22 to this issue.
amiramusa187-glitch commentedon Aug 27, 2026
@amiramusa187-glitch has applied to work on this issue as part of the Stellar Wave Program's 8th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @amiramusa187-glitch to this issue.
Chidimj commentedon Aug 30, 2026
@Chidimj has applied to work on this issue as part of the Stellar Wave Program's 8th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @Chidimj to this issue.
drips-wave commentedon Aug 30, 2026
Congratulations, @Chidimj! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.
🧑💻 @Chidimj: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.
Warning
When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.
🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.
🌊 Happy Wave 🌊
docs: add documentation index and map (#589)
github-actions commentedon Aug 30, 2026
Closed by #593, merged into
dev.drips-wave commentedon Aug 30, 2026
This issue has been completed by @Chidimj as part of the Stellar Wave Program's 8th Wave 🥳
😎 @Chidimj: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.
🧑💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.