Skip to content

docs(site): expand TypeDoc API reference to the public surface (#3949)#3950

Merged
williamzujkowski merged 1 commit into
mainfrom
docs/3949-typedoc-surface
Jun 18, 2026
Merged

docs(site): expand TypeDoc API reference to the public surface (#3949)#3950
williamzujkowski merged 1 commit into
mainfrom
docs/3949-typedoc-surface

Conversation

@williamzujkowski

Copy link
Copy Markdown
Collaborator

Closes #3949.

#3763 wired generated TypeDoc markdown into the website /api/ collection but scoped packages/nexus-agents/typedoc.markdown.json to a single entry point (src/core/result.ts). This expands it to the curated public API surface.

entryPoints chosen

Switched entryPoints from ["src/core/result.ts"] to the explicit list of the 19 non-test barrels in src/exports/ (excluding export-contracts.test.ts and security-export-contracts.test.ts):

core, config, adapters, agents, agents-skills, agents-ictm, workflows, mcp, cli-adapters, context, learning, audit, security, consensus, observability, orchestration, benchmarks, pipeline, scm

Preferred the explicit barrel list over src/exports/index.ts for clean per-module pages (one page per domain), per the issue. outputFileStrategy: "modules" kept. excludePrivate/excludeInternal already on.

Note: used the full set of non-test barrels actually present in src/exports/ — this includes security.ts and workflows.ts, which the issue's enumerated list omitted but which src/exports/index.ts re-exports as part of the public surface.

Generated page count

20 markdown pages (index + 19 module pages) — well within the reasonable range; no build blowup, no scoping-down needed. (Baseline was 1 page.)

TypeDoc placed 3 pages under docs/api/exports/ (agents-ictm, benchmarks, pipeline) where it disambiguates colliding inferred module names; the rest are top-level. The /api/[...slug] route already maps the index page to the section root and uses entry.id for slugs, so the nested pages render correctly; cross-page links use correct relative paths (e.g. ../core.md from within exports/). The /api/ index lists all modules and is navigable as-is.

Website build result

  • pnpm --filter nexus-agents-website build: green — 129 pages, all 20 /api/ pages rendered (including the 3 nested exports/* and the root /api/).
  • astro check: 0 errors, 0 warnings, 1 pre-existing hint (unrelated is:inline hint in BaseLayout.astro).

Scoping-down

None required — page count is small.

Notes

  • No website prebuild re-added; generation stays decoupled via pnpm -C packages/nexus-agents docs:api:md. Committed the regenerated docs/api/** per the committed-generated-docs convention.
  • Required building the nexus-memory workspace package first (pnpm -C packages/nexus-memory build) so TypeDoc could resolve its declarations.
  • TypeDoc emitted 187 warnings (referenced-but-not-exported internal symbols / unresolved JSDoc links) and 0 errors — expected when documenting curated barrels that reference internal types.

🤖 Generated with Claude Code

Change typedoc.markdown.json entryPoints from the single src/core/result.ts
to the 19 curated public barrels under src/exports/ (excluding the two
*-export-contracts.test.ts files). Regenerate the committed docs/api/ markdown
(outputFileStrategy: modules). Generation stays decoupled via the
docs:api:md script (no website prebuild re-added).

20 generated pages (index + 19 modules); 3 land under exports/ where TypeDoc
disambiguates colliding inferred module names (agents-ictm, benchmarks,
pipeline). The /api/[...slug] route already maps the index page to the section
root and uses entry.id for nested slugs, so the nested pages render.

Website build green, /api/ pages render (20 html pages incl. nested), astro
check clean (0 errors).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@williamzujkowski williamzujkowski merged commit c5a73de into main Jun 18, 2026
41 checks passed
@williamzujkowski williamzujkowski deleted the docs/3949-typedoc-surface branch June 18, 2026 05:24
@github-project-automation github-project-automation Bot moved this from Backlog to Done in nexus-agents project Jun 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant