Skip to content

Documentation index and map #589

Description

@codebestia

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 .md in 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions