Skip to content

TypeDoc @category sweep + reference landing page #172

Description

@truthixify

Tier: S (1-2 days) | Type: docs

Context. Wave 6 shipped the auto-generated TypeDoc site (PR #110) but the landing page dumps every export in one alphabetical wall. typedoc.json is 8 lines with no categoryOrder or custom template, and no source file carries @category today (verified via grep). Api-extractor uses @internal on non-public symbols but does not enforce @public on the rest (ae-missing-release-tag is set to none). We can group exports by concern (keys, addresses, scanning, transactions, errors) so a first-time reader can find deriveStealthKeys without ctrl-F.

Scope.

  • Add @category tags to every public export across src/index.ts and each chain entry.
  • Add @example blocks to the top 15 most-used exports (identified from README + guides).
  • Configure typedoc.json with a categoryOrder and a custom index template.
  • Regenerate and eyeball the output for each chain page.

Acceptance.

  • pnpm docs output groups exports under Keys / Addresses / Scanning / Transactions / Errors / Advanced
  • Every @public symbol has a category
  • At least 15 exports carry a runnable @example
  • CI check ensures a new @public export without a @category fails the build

Files. src/index.ts, src/chains/*/index.ts, typedoc.json, .github/workflows/ci.yml.

Activity

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

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programdocsDocumentationdripsFunded via Drips NetworkdxDeveloper experiencehelp wantedExtra attention is neededstellar-waveAuto-created for Wave 8wave-8Auto-created for Wave 8

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions