Skip to content

docs(site): expand TypeDoc API-reference entry points beyond result.ts to the public API surface (follow-up to #3763) #3949

@williamzujkowski

Description

@williamzujkowski

Follow-up from #3763 (PR #3948), which wired the generated TypeDoc markdown into the Astro website as a rendered `/api/` content collection + route (pipeline proven end-to-end, site builds green).

To keep the proving increment fast, `packages/nexus-agents/typedoc.markdown.json` is scoped to a single canonical entry point (`src/core/result.ts`, ~9 exports / 1 page).

This issue: expand the typedoc entry points to cover the intended public API surface (the canonical-path modules / src/exports/** / the 46 MCP tools), so the website API reference is actually useful. Watch for: build time / page count blowup (scope to PUBLIC exports, not all 8740), and frontmatter/route handling at scale (the `[...slug].astro` route + `typedoc-plugin-frontmatter` + `scripts/typedoc-astro-title.mjs` already handle nested pages — verify at volume). Ties into #3688 (cut ENTRYPOINTS/README API text over to generated output) and epic #3532.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions