align mintlify nav with current docs structure#2526
Conversation
swstica
requested review from
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
Greptile SummaryThis PR aligns the Mintlify navigation configuration in
Confidence Score: 5/5Safe to merge — all newly added nav entries map to confirmed files on disk, and the structural changes are well-formed Mintlify navigation. Every new page reference introduced in this PR has a corresponding .md file in the repository. The group rename from Agents to Coding agents correctly updates all child paths, and the Navigation group flattening is valid. No nav entries point to missing files. No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "update and add missing pages from mint d..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| "pages": [ | ||
| "capabilities/teleoperation/hosted" | ||
| ] | ||
| } |
There was a problem hiding this comment.
capabilities/teleoperation/hosted
The nav entry capabilities/teleoperation/hosted has no corresponding source file — docs/capabilities/teleoperation/ does not exist at all. Mintlify will render a broken/404 entry in the sidebar for this group, and clicking it will return a page-not-found error.
| "agents/testing", | ||
| "coding-agents/index", | ||
| "coding-agents/style", | ||
| "coding-agents/code-quality-rules", |
There was a problem hiding this comment.
coding-agents/code-quality-rules
docs/coding-agents/code-quality-rules.md does not exist in the repository. Adding it to the nav will produce a broken sidebar link that 404s for visitors.
| @@ -49,6 +50,7 @@ | |||
| { | |||
| "group": "Data streams", | |||
| "pages": [ | |||
| "usage/data_streams/readme", | |||
There was a problem hiding this comment.
The three new entries usage/readme, usage/data_streams/readme, and usage/sensor_streams/readme reference lowercase readme, but the actual files on disk are docs/usage/README.md, docs/usage/data_streams/README.md, and docs/usage/sensor_streams/README.md (all uppercase). On the case-sensitive Linux filesystem where Mintlify typically deploys, these lookups will fail to resolve the file, resulting in 404s. The other pages in this codebase all use lowercase filenames consistently — consider renaming the three README.md files to readme.md.
| "group": "Coding agents", | ||
| "pages": [ | ||
| "agents/index", | ||
| "agents/style", | ||
| "agents/testing", | ||
| "coding-agents/index", | ||
| "coding-agents/style", | ||
| "coding-agents/code-quality-rules", | ||
| "coding-agents/testing", | ||
| "coding-agents/worktrees", | ||
| { | ||
| "group": "Authoring agent docs", | ||
| "pages": [ | ||
| "agents/docs/index", | ||
| "agents/docs/codeblocks", | ||
| "agents/docs/doclinks" | ||
| "coding-agents/docs/index", | ||
| "coding-agents/docs/codeblocks", | ||
| "coding-agents/docs/doclinks" | ||
| ] | ||
| } | ||
| ] |
There was a problem hiding this comment.
agents/* paths to new coding-agents/* paths
The group was renamed from agents to coding-agents and all page paths updated accordingly, but no redirects entries have been added to docs.json for the old URLs (agents/index, agents/style, agents/testing, agents/docs/index, etc.). Anyone who bookmarked or linked to those pages will hit 404s. Mintlify supports "redirects": [{"source": "/agents/index", "destination": "/coding-agents/index"}] entries at the top level of docs.json.
swstica
force-pushed
the
swastika/fix/mint-config
branch
from
b3eee54 to
b47e1f8
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #2526 +/- ##
==========================================
- Coverage 69.97% 69.97% -0.01%
==========================================
Files 842 842
Lines 74420 74420
Branches 6668 6668
==========================================
- Hits 52077 52075 -2
- Misses 20636 20638 +2
Partials 1707 1707
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
github-actions
Bot
added
the
ready-to-merge
1 participant
added mintlify pages that were missing in docs.json