Skip to content

Use $ref for localized navigation objects#5438

Merged
ethanpalm merged 3 commits intomainfrom
split-refs-for-languages
Apr 17, 2026
Merged

Use $ref for localized navigation objects#5438
ethanpalm merged 3 commits intomainfrom
split-refs-for-languages

Conversation

@ethanpalm
Copy link
Copy Markdown
Collaborator

@ethanpalm ethanpalm commented Apr 17, 2026

Documentation changes

Makes docs.json easier to maintain


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Pure documentation configuration refactor; main risk is broken locale navigation if $ref resolution or file paths are misconfigured.

Overview
Refactors localized documentation navigation to be maintained as separate JSON files.

In docs.json, the large inline navigation.languages entries for French, Spanish, and Chinese are replaced with $ref pointers to fr.json, es.json, and zh.json, and those new files are added containing the same tab/group/page structures per locale.

Reviewed by Cursor Bugbot for commit f16dbc8. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 17, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 17, 2026, 7:11 PM

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ethanpalm ethanpalm merged commit 877f901 into main Apr 17, 2026
4 checks passed
@ethanpalm ethanpalm deleted the split-refs-for-languages branch April 17, 2026 19:17
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