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.
Files. src/index.ts, src/chains/*/index.ts, typedoc.json, .github/workflows/ci.yml.
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.jsonis 8 lines with nocategoryOrderor custom template, and no source file carries@categorytoday (verified via grep). Api-extractor uses@internalon non-public symbols but does not enforce@publicon the rest (ae-missing-release-tagis set tonone). We can group exports by concern (keys, addresses, scanning, transactions, errors) so a first-time reader can findderiveStealthKeyswithout ctrl-F.Scope.
@categorytags to every public export acrosssrc/index.tsand each chain entry.@exampleblocks to the top 15 most-used exports (identified from README + guides).typedoc.jsonwith acategoryOrderand a custom index template.Acceptance.
pnpm docsoutput groups exports under Keys / Addresses / Scanning / Transactions / Errors / Advanced@publicsymbol has a category@example@publicexport without a@categoryfails the buildFiles.
src/index.ts,src/chains/*/index.ts,typedoc.json,.github/workflows/ci.yml.