Repository navigation
build(docs): generate the api references with typedoc and a mintlify navigation - #469
Merged
Merged
Conversation
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.
What does this PR do?
Refs #462 (the 2.0.0 references reach the site at the next engine release, with the new docs-sync).
Replaces the mint-tsdocs API reference generator with one TypeDoc run, and gives the docs pages clean slugs and an explicit navigation (docs layout of NanoForge-dev/actions#117).
pnpm run docs=turbo run build && typedoc→docs/references/<package>/**.mdx+docs/references/navigation.jsondocscatalog),sanitizeCommentsfor MDXdocs/typedoc/mintlify.mjs: frontmatter (title,descriptionfrom the summary) and the navigation (one group per package, subgroups by kind)typedoc.jsononly for multi-entry packages (ecs, input, network)mint-tsdocs.config.json,tsdoc.json,scripts/sync-docs-references.sh, per-packagedocsscripts, the turbodocstaskdocs/docs: no1-/ snake_case slugs, file-relative links,docs/docs/navigation.json, the body H1 that repeated each title removed,getting-started/documentation.mdxrewritten (it described Sphinx)common(inline code wrapping onto a line starting with{broke MDX)Note: on pnpm 12
pnpm docsis pnpm's built-in command; usepnpm run docs(docs-sync does).How do you test this PR?
/snippets/tsdocs/PageLink.jsx/RefLink.jsx, which the docs repo gitignores, and leaked a.tsdocscache.pnpm run docs: 0 errors, 14 TSDoc warnings (docs: fix the TypeDoc warnings and hide the protected internals of NetworkServerLibrary #468), 432 pages, all listed once in the navigation, all titled. Full docs-sync with references into a scratch docs clone:mint validatesuccess,mint broken-linksno broken links.docs/docs: 23 pages, all listed, validate/broken-links/a11y pass.pnpm build13/13,pnpm run docs,pnpm lint25/25; push hook ran unit and e2e tests (pass).Merge danger
Door: two-way (revert). The page renames change public URLs once synced; the docs PR adds redirects.
Blast radius: engine tooling only; no package API change (one TSDoc comment).
Order: release NanoForge-dev/actions#117 as 3.2.0 first. Until then the old
@v3sync would copy these renamed pages next to the old ones and regenerate the docs repodocs.json. Then merge this PR, and NanoForge-dev/docs (opened next) last. After NanoForge-dev/actions#117, a release of this repo without this PR fails the docs step before writing anything (safe,continue-on-error).Follow-up issues
Quality gate
docs/docspages and navigation,getting-started/documentation.mdxpnpm run docsreuses the build cache of the release job; TypeDoc ~21 sdocs(engine)is not a package name