Skip to content

docs.json navigation cleanup for shipped Wave 7 pages #122

Description

@truthixify

Tier: S (1-2 days) | Type: chore

Context. Wave 7 landed a large batch of new pages but docs.json (the Mintlify nav) was never updated for most of them. Pages that exist on disk but are absent from the nav include guides/stellar/stellar-quickstart, guides/stellar/wraith-names-lifecycle, guides/integrations/blend, guides/integrations/soroswap, guides/integrations/reflector, guides/integrations/react-native, reference/security-disclosure, reference/threat-model, reference/audits, reference/stellar-networks, architecture/view-tag-scanner, architecture/announcement-format, and the ES translations (*.es.mdx). Readers can only reach them via search or direct link, which is the wrong default.

Scope.

  • Audit every .mdx under guides/, reference/, concepts/, architecture/, api-reference/, sdk/ against the docs.json tree; add any missing page under its natural section.
  • Add locale groups for es where an .es.mdx variant exists (Mintlify supports per-locale navigation entries).
  • Order new entries alphabetically within each group unless there is an existing curated order.
  • Add a comment header in docs.json naming the audit script (below) so future waves can rerun it.
  • Add scripts/check-nav-coverage.mjs: scans mdx files and fails if any is missing from docs.json; wire it into the Compile docs snippets CI job.

Acceptance.

  • Every existing mdx page in the shipped taxonomy is reachable from docs.json
  • scripts/check-nav-coverage.mjs exits 0 on the current tree
  • CI fails a PR that adds an mdx page without registering it in docs.json
  • Renders in mint dev

Files. docs.json, scripts/check-nav-coverage.mjs (new), .github/workflows/ci.yml.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programchoreAuto-created for Wave 8docsDocumentationdripsFunded via Drips Networkhelp wantedExtra attention is needednavAuto-created for Wave 8stellar-waveAuto-created for Wave 8wave-8Auto-created for Wave 8writing

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions