docs(site): expand TypeDoc API reference to the public surface (#3949)#3950
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3949.
#3763 wired generated TypeDoc markdown into the website
/api/collection but scopedpackages/nexus-agents/typedoc.markdown.jsonto a single entry point (src/core/result.ts). This expands it to the curated public API surface.entryPoints chosen
Switched
entryPointsfrom["src/core/result.ts"]to the explicit list of the 19 non-test barrels insrc/exports/(excludingexport-contracts.test.tsandsecurity-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, scmPreferred the explicit barrel list over
src/exports/index.tsfor clean per-module pages (one page per domain), per the issue.outputFileStrategy: "modules"kept.excludePrivate/excludeInternalalready on.Note: used the full set of non-test barrels actually present in
src/exports/— this includessecurity.tsandworkflows.ts, which the issue's enumerated list omitted but whichsrc/exports/index.tsre-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 theindexpage to the section root and usesentry.idfor slugs, so the nested pages render correctly; cross-page links use correct relative paths (e.g.../core.mdfrom withinexports/). 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 nestedexports/*and the root/api/).astro check: 0 errors, 0 warnings, 1 pre-existing hint (unrelatedis:inlinehint inBaseLayout.astro).Scoping-down
None required — page count is small.
Notes
pnpm -C packages/nexus-agents docs:api:md. Committed the regenerateddocs/api/**per the committed-generated-docs convention.nexus-memoryworkspace package first (pnpm -C packages/nexus-memory build) so TypeDoc could resolve its declarations.🤖 Generated with Claude Code