Skip to content

docs: write docs.json by hand with a $ref to each repository's navigation - #6

Merged
Exeloo merged 11 commits into
mainfrom
feat/docs-navigation
Nov 7, 2026
Merged

Exeloo merged 11 commits into
mainfrom
feat/docs-navigation

Conversation

@Exeloo

@Exeloo Exeloo commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

What does this PR do?

Refs NanoForge-dev/Engine#462 (the engine 2.0.0 API references arrive with the next engine release).

The site's navigation is no longer generated from folder names. docs.json is written by hand and includes the navigation.json that each repo's docs-sync writes into its own folder (Mintlify $ref):

docs.json            theme, tabs, dropdowns, redirects (owned here)
index.mdx            new home page
docs/<repo>/         engine, cli, loader, editor: pages + navigation.json   (owned by that repo)
guides/cli/          CLI guides + navigation.json                           (owned by cli)
references/engine/   API reference versions + navigation.json               (owned by engine)

How do you test this PR?

  • pnpm validate (mint, node 24): "build validation passed". Before the content fixes it reported 23 invalid mintlify/components imports.
  • pnpm broken-links: no broken links. pnpm a11y: no issues (80 MDX files). pnpm lint: pass. actionlint on tests.yml: exit 0.
  • A scratch clone with a full engine references sync (432 pages): validate and broken-links pass, the placeholder removed.
  • Checked that docs.nanoforge.eu serves main directly (the 2026-10-04 loader pages are live), so the merge publishes the new site.

Merge danger

Door: two-way through a revert, but merging deploys the live site at once.
Blast radius: the whole public docs site.
Order: merge last:

  1. feat(docs-sync)!: sync each repo's folders from its own navigation files actions#117 released as 3.2.0. Before that, any engine/cli/loader/editor release would overwrite this hand-written docs.json.
  2. build(docs): generate the api references with typedoc and a mintlify navigation Engine#469, docs: drop number prefixes from page names and add an explicit navigation CLI#253, docs: own the loader folder of the docs site with an explicit navigation Loader#124, docs: add the navigation of the docs site pages Editor#225.
  3. This PR. If any of those changed in review, re-sync them into this branch first.

Follow-up issues

Quality gate

Check Result Notes
Docs Updated README (how the site is made, commands)
Correctness Pass after fixes stale cli output re-synced; redirects to / and the cli getting-started folder added
Performance Pass editor PNGs up to 227 KB, from the editor repo
Accessibility Pass mint a11y; heading order and link text checked
Security Pass tests.yml: contents: read, persist-credentials: false, pull_request only; no internal URLs
Style Pass prettier

@Exeloo
Exeloo merged commit 0d60254 into main Nov 7, 2026
2 checks passed
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.

1 participant