docs: use flat navigation.pages for multi-repo sourceRef#386
Merged
Conversation
The base docs site mounts this SDK via a `sourceRef` inside a `pages` context; Mintlify requires the referenced source to define the same navigation type as its mount slot. navigation.groups tripped "does not define navigation.pages". Switch docs/docs.json to a flat navigation.pages array (overview first, then service pages alphabetically) and update scripts/gen-docs-nav.sh to emit it. The docs-nav.yaml workflow already calls the script, so no workflow change.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
The base docs site mounts each SDK via a Mintlify
sourceRefplaced inside apagescontext. Mintlify requires the referenced source to define the same navigation type as its mount slot, so the group-basednavigation.groupswe shipped triggered:This switches
docs/docs.jsonto a flatnavigation.pagesarray (overview first, then service pages alphabetically) and updatesscripts/gen-docs-nav.shto emit that shape. Group headers are supplied by the base site around thesourceRef.The
docs-nav.yamlworkflow already callsscripts/gen-docs-nav.sh, so no workflow change is needed.Verified locally
navigation.pages, overview first, alphabetical ✓$schema/theme/name/colors preserved ✓Test plan