chore: register Wave 7 pages in docs.json and add nav coverage check (Closes #122) - #135
Open
franklin251861-killer wants to merge 1 commit into
Conversation
…loses wraith-protocol#122) Wave 7 shipped many pages that were missing from the Mintlify navigation tree, leaving them reachable only via search or direct link. Register every on-disk page in its natural group, merge the duplicate Integrations groups, drop the dangling reference/stellar-event-schemas nav entry (the file no longer exists), and add the es locale variant next to its English source. Add scripts/check-nav-coverage.mjs, which fails when an .mdx page is missing from docs.json or a nav entry has no file, and wire it into the Compile docs snippets CI job so future waves cannot skip registration. Docs.json is strict JSON (the Mintlify CLI rejects comments), so the audit script is documented in docs/CONTRIBUTING.md instead of a comment header.
|
@franklin251861-killer Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
1 participant
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.
Summary
Closes #122 — Wave 7 shipped a large batch of pages that were never registered in the Mintlify navigation tree (
docs.json), so readers could only reach them via search or direct link.Changes
docs.jsonarchitecture/announcement-formatreference/stellar-networksguides/stellar-quickstart(+guides/stellar-quickstart.esper the repo's i18n convention),guides/stellar-wallet-integrationblend,react-native,reflector,soroswapguides/stellar/passkey-signing,guides/stellar/stellar-quickstart,guides/stellar/wraith-names-lifecycleapi-reference/stealth-keysreference/stellar-event-schemasnav entry — the file was deleted indb12d1band never re-added; the sidebar was linking to a 404 (confirmed bymint validate).New:
scripts/check-nav-coverage.mjs.mdxpage in the shipped taxonomy is missing fromdocs.json, or when a nav entry has no matching file. Handles JSONC comments, nested groups, and external links.CI — added a "Check nav coverage" step to the "Compile docs snippets" job in
.github/workflows/snippets.yml, pluscheck:nav-coverageinpackage.json(also chained intonpm test).Note on the comment header: the issue asked for a comment header in
docs.json, but the Mintlify CLI (mint validate, used for "renders in mint dev") rejects comments indocs.jsonwith "invalid JSON". Instead the audit script is documented indocs/CONTRIBUTING.md, including an explicit warning to keepdocs.jsoncomment-free.Verification
pnpm run check:snippets— passed (572 snippets)pnpm run check:nav-coverage— passed (59 pages / 59 nav entries)mint validate— nav-related warning fixed (4 warnings → 3); the remaining 3 warnings are pre-existing MDX content issues incontracts/stellar.mdx,reference/stellar-networks.mdx, andguides/stellar-explorer-recipes.mdx, present ondevelopbefore this change and unrelated to navigation.