docs: align Mintlify navigation with index.md pages and front matter#2560
Open
swstica wants to merge 2 commits into
Open
docs: align Mintlify navigation with index.md pages and front matter#2560swstica wants to merge 2 commits into
swstica wants to merge 2 commits into
Conversation
swstica
requested review from
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
Contributor
Greptile SummaryThis PR aligns Mintlify navigation with the docs content:
Confidence Score: 3/5Several newly created index pages contain broken internal links that will 404 in the rendered Mintlify site; the core nav fixes in docs.json are correct. Five new overview pages all use the docs/capabilities/manipulation/index.md and docs/capabilities/navigation/index.md (new files with broken links not yet addressed); docs/usage/index.md, docs/usage/data_streams/index.md, and docs/usage/sensor_streams/index.md (same broken-link pattern flagged in prior review rounds). Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[docs.json navigation] --> B[Usage group]
A --> C[Agents group]
A --> D[Capabilities group]
A --> E[Development group]
B --> B1[usage/index ✅]
B --> B2[usage/modules, blueprints, config…]
B --> B3[Data streams group]
B --> B4[Sensor streams group]
B3 --> B3a[data_streams/index ⚠️ broken links]
B4 --> B4a[sensor_streams/index ⚠️ broken links]
B1 --> B1n[⚠️ broken links inside page]
C --> C1[coding-agents/index ✅ fixed from agents/]
C --> C2[coding-agents/style, testing, worktrees…]
C --> C3[Authoring agent docs subgroup]
D --> D1[Agents → capabilities/agents/index ✅]
D --> D2[Manipulation group]
D --> D3[Mapping group ✅ new]
D --> D4[Navigation group]
D --> D5[Perception group ✅ new]
D --> D6[Teleoperation group]
D2 --> D2a[manipulation/index ⚠️ broken links]
D4 --> D4a[navigation/index ⚠️ broken links]
E --> E1[development/releasing ✅ new]
%%{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[docs.json navigation] --> B[Usage group]
A --> C[Agents group]
A --> D[Capabilities group]
A --> E[Development group]
B --> B1[usage/index ✅]
B --> B2[usage/modules, blueprints, config…]
B --> B3[Data streams group]
B --> B4[Sensor streams group]
B3 --> B3a[data_streams/index ⚠️ broken links]
B4 --> B4a[sensor_streams/index ⚠️ broken links]
B1 --> B1n[⚠️ broken links inside page]
C --> C1[coding-agents/index ✅ fixed from agents/]
C --> C2[coding-agents/style, testing, worktrees…]
C --> C3[Authoring agent docs subgroup]
D --> D1[Agents → capabilities/agents/index ✅]
D --> D2[Manipulation group]
D --> D3[Mapping group ✅ new]
D --> D4[Navigation group]
D --> D5[Perception group ✅ new]
D --> D6[Teleoperation group]
D2 --> D2a[manipulation/index ⚠️ broken links]
D4 --> D4a[navigation/index ⚠️ broken links]
E --> E1[development/releasing ✅ new]
Reviews (3): Last reviewed commit: "add nav index to sidebar and title CMU n..." | 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}
Comment on lines
9
to
13
| - [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). |
Contributor
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.
Suggested change
| - [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). |
❌ 2 Tests Failed:
View the full list of 2 ❄️ flaky test(s)
To view more test analytics, go to the Test Analytics Dashboard |
github-actions
Bot
added
the
ready-to-merge
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.
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