docs: align Mintlify navigation with index.md pages and front matter#2560
docs: align Mintlify navigation with index.md pages and front matter#2560swstica wants to merge 5 commits into
Conversation
swstica
requested review from
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
Greptile SummaryThis PR renames all
Confidence Score: 4/5Safe to merge for the navigation and frontmatter fixes; existing broken links in the new index pages (flagged in earlier review rounds) still need a follow-up. The coding-agents path fix, readme→index renames, and frontmatter additions all look correct. Two nav entries (coding-agents/worktrees and development/releasing) were added to docs.json without receiving the same frontmatter treatment as the rest of the PR, so Mintlify will derive their sidebar labels from the raw filenames. The broken internal-link format in usage/index.md, data_streams/index.md, and sensor_streams/index.md was already noted in earlier review rounds and remains unresolved. docs/coding-agents/worktrees.md and docs/development/releasing.md — both newly exposed in the sidebar but missing title frontmatter. The three index files under docs/usage/ that carry broken Mintlify-incompatible link paths. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[readme.md / README.md files] -->|renamed to| B[index.md files]
B -->|frontmatter added| C[title: in frontmatter]
C -->|registered in| D[docs.json navigation]
E[agents/ paths in docs.json] -->|fixed to| F[coding-agents/ paths]
F --> D
G[New pages added to nav] --> D
G --> G1[usage/index]
G --> G2[data_streams/index]
G --> G3[sensor_streams/index]
G --> G4[capabilities/agents/index]
G --> G5[capabilities/perception/index]
G --> G6[coding-agents/worktrees no frontmatter]
G --> G7[development/releasing no frontmatter]
D -->|renders| H[Mintlify sidebar with correct titles]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[readme.md / README.md files] -->|renamed to| B[index.md files]
B -->|frontmatter added| C[title: in frontmatter]
C -->|registered in| D[docs.json navigation]
E[agents/ paths in docs.json] -->|fixed to| F[coding-agents/ paths]
F --> D
G[New pages added to nav] --> D
G --> G1[usage/index]
G --> G2[data_streams/index]
G --> G3[sensor_streams/index]
G --> G4[capabilities/agents/index]
G --> G5[capabilities/perception/index]
G --> G6[coding-agents/worktrees no frontmatter]
G --> G7[development/releasing no frontmatter]
D -->|renders| H[Mintlify sidebar with correct titles]
Reviews (7): Last reviewed commit: "Merge branch 'main' into swastika/fix/mi..." | Re-trigger Greptile |
Co-authored-by: Cursor <cursoragent@cursor.com>
swstica
force-pushed
the
swastika/fix/mint-pages-format
branch
from
add1470 to
40ec0b6
Compare
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| - [Modules](/docs/usage/modules.md): The primary units of deployment in DimOS, modules run in parallel and are python classes. | ||
| - [Streams](/docs/usage/sensor_streams/README.md): How modules communicate, a Pub / Sub system. | ||
| - [Streams](/docs/usage/sensor_streams/index.md): How modules communicate, a Pub / Sub system. | ||
| - [Blueprints](/docs/usage/blueprints.md): a way to group modules together and define their connections to each other. | ||
| - [RPC](/docs/usage/blueprints.md#calling-the-methods-of-other-modules): how one module can call a method on another module (arguments get serialized to JSON-like binary data). | ||
| - [Skills](/docs/usage/blueprints.md#defining-skills): An RPC function, except it can be called by an AI agent (a tool for an AI). |
There was a problem hiding this comment.
/docs/usage/…filename.md pattern, which will resolve to docs/docs/usage/… in Mintlify and produce 404s. The .md extension and the /docs/ prefix both need to be removed. The blueprints.md page is also not listed in docs.json navigation — linking to it is fine (Mintlify will serve hidden pages by URL), but it won't appear in the sidebar.
| - [Modules](/docs/usage/modules.md): The primary units of deployment in DimOS, modules run in parallel and are python classes. | |
| - [Streams](/docs/usage/sensor_streams/README.md): How modules communicate, a Pub / Sub system. | |
| - [Streams](/docs/usage/sensor_streams/index.md): How modules communicate, a Pub / Sub system. | |
| - [Blueprints](/docs/usage/blueprints.md): a way to group modules together and define their connections to each other. | |
| - [RPC](/docs/usage/blueprints.md#calling-the-methods-of-other-modules): how one module can call a method on another module (arguments get serialized to JSON-like binary data). | |
| - [Skills](/docs/usage/blueprints.md#defining-skills): An RPC function, except it can be called by an AI agent (a tool for an AI). | |
| - [Modules](/usage/modules): The primary units of deployment in DimOS, modules run in parallel and are python classes. | |
| - [Streams](/usage/sensor_streams/index): How modules communicate, a Pub / Sub system. | |
| - [Blueprints](/usage/blueprints): a way to group modules together and define their connections to each other. | |
| - [RPC](/usage/blueprints#calling-the-methods-of-other-modules): how one module can call a method on another module (arguments get serialized to JSON-like binary data). | |
| - [Skills](/usage/blueprints#defining-skills): An RPC function, except it can be called by an AI agent (a tool for an AI). |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #2560 +/- ##
========================================
Coverage 71.34% 71.34%
========================================
Files 891 891
Lines 80517 80517
Branches 7323 7462 +139
========================================
+ Hits 57443 57446 +3
+ Misses 21144 21142 -2
+ Partials 1930 1929 -1
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
github-actions
Bot
removed
the
ready-to-merge
github-actions
Bot
added
the
ready-to-merge
github-actions
Bot
added
ready-to-merge
|
@greptile quick check |
| "group": "Agents", | ||
| "pages": [ | ||
| "capabilities/agents/index" | ||
| ] | ||
| }, |
There was a problem hiding this comment.
The new "Mapping" group references "capabilities/mapping/relocalization", but no file at docs/capabilities/mapping/relocalization.md exists in the repository. The capabilities/mapping/ directory itself doesn't exist. Mintlify will render a broken sidebar entry and a 404 page. The relocalization content already lives at capabilities/navigation/relocalization.md, which is listed under the "Navigation" group — this entry may be a mistaken duplicate of that path.
github-actions
Bot
removed
the
ready-to-merge
github-actions
Bot
added
the
ready-to-merge
2 participants
Problem
Solution
readme.mdpages toindex.md. This change occurs for GH preview as well but we don't have any option if we want to keep same docs for GH and mintlify.title: xyzacross 52 docs pages. Mintlify takes file name as default title if not mentioned. eg: it will take 'index' as a page name for 'index.md' file, which would be confusing.docs.jsonfor nav.How to Test
cd docs && npx mint devContributor License Agreement