Swastika/mint docs/new pages by swstica · Pull Request #2071 · dimensionalOS/dimos

swstica · 2026-05-13T09:19:29Z

Merge order: 1/3- This PR can be merged independently.

Problem

Docs folder has no Mintlify configuration and is missing logo, introduction and quickstart pages.

Solution

Added docs.json with Mintlify config (theme, colors, logo, sidebar) and full navigation structure accounting for upcoming docs restructuring.
Added Dimensional logo in assets folder for Mintlify light/dark theme.
Added introduction.mdx - overview of DimOS with capabilities at a glance.
Added quickstart.mdx - install instructions, replay/simulation/real robot setup, CLI and MCP usage, featured runfiles.

How to Test

cd docs
npm i -g mintlify
mintlify dev

Contributor License Agreement

I have read and approved the CLA.

greptile-apps · 2026-05-13T09:23:54Z

Greptile Summary

This PR bootstraps the Mintlify docs site for DimOS by adding docs.json (theme, colors, logo, full sidebar navigation), an introduction.mdx overview with capability cards, and a quickstart.mdx covering install, replay/simulation/real-robot setup, CLI, and MCP usage. Several navigation path and broken-link issues identified in earlier review rounds were fixed before merge via follow-up commits.

docs.json maps every sidebar entry to a real file in the repository; the Getting Started, Usage, Capabilities, Platforms, Development, and For Agents groups are all wired up correctly after the fix commits.
introduction.mdx and quickstart.mdx card href values resolve to existing files; the previously broken /usage/concepts, /troubleshooting/replay, and duplicate agent card links have been removed or corrected.
One minor inconsistency remains: favicon uses a bare relative path (assets/favicon.png) while the logo block uses root-relative paths (/assets/...), which can behave differently in Mintlify depending on the deployment base URL.

Confidence Score: 5/5

Documentation-only change adding Mintlify config and two new MDX pages — no runtime code is touched.

All navigation slugs in docs.json map to real files on disk after multiple fix commits addressing the originally broken paths. Card hrefs in both MDX pages resolve to existing documents. The change is entirely additive and isolated to the docs directory.

No files require special attention.

Important Files Changed

Filename	Overview
docs/docs.json	New Mintlify config. All nav paths now match real files after multiple fix commits; minor inconsistency: favicon uses a bare relative path while logo entries use a leading-slash path.
docs/introduction.mdx	New introduction page; all card hrefs now resolve to existing files in the repository.
docs/quickstart.mdx	New quickstart page; platform link and card hrefs updated to correct nested paths after fix commits.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[docs.json] --> B[Getting Started]
    A --> C[Usage]
    A --> D[Capabilities]
    A --> E[Platforms]
    A --> F[Development]
    A --> G[For Agents]

    B --> B1[introduction.mdx]
    B --> B2[quickstart.mdx]
    B --> B3[requirements.md]
    B --> B4[installation/ubuntu\ninstallation/osx\ninstallation/nix]

    C --> C1[usage/README\nblueprints, modules, cli, ...]
    C --> C2[Data Streams group]
    C --> C3[Sensor Streams group]
    C --> C4[Transports group]

    D --> D1[capabilities/agents/readme]
    D --> D2[Navigation group\nnavigation/readme + native/index]
    D --> D3[Manipulation group]
    D --> D4[Memory group]
    D --> D5[capabilities/perception/readme]

    E --> E1[platforms/quadruped/go2/index]
    E --> E2[platforms/humanoid/g1/index]

    F --> F1[development/docker\ntesting, profiling, ...]
    G --> G1[agents/index\nagents/style\nagents/testing\nagents/docs/*]

_{Reviews (5): Last reviewed commit: "fix greptile error: remove duplicate pat..." | Re-trigger Greptile}

greptile-apps · 2026-05-13T09:23:58Z

+  First replay failing? Most issues are network or LFS related. See [Replay troubleshooting](/troubleshooting/replay).
+</Note>


Broken link to non-existent troubleshooting page

/troubleshooting/replay is linked in the live quickstart content but this page does not exist in the file system or in the docs.json navigation. Users who hit a replay failure and follow the link will land on a 404. A troubleshooting/ group should be added to the navigation, or this sentence should be removed/replaced with a GitHub Issues link until the page is written.

greptile-apps · 2026-05-13T09:23:59Z

+          "pages": [
+  "platforms/quadruped-go2",
+            "platforms/humanoid-g1"
+          ]


Platform nav paths don't match the actual directory structure

The navigation uses platforms/quadruped-go2 and platforms/humanoid-g1, but the existing files live at platforms/quadruped/go2/index.md and platforms/humanoid/g1/index.md. Mintlify resolves slugs from file paths, so both sidebar links will 404. Either rename the directories to platforms/quadruped-go2/ and platforms/humanoid-g1/, or update the nav entries to platforms/quadruped/go2 and platforms/humanoid/g1.

greptile-apps · 2026-05-13T09:24:00Z

+              "group": "Navigation",
+              "pages": [
+                "capabilities/navigation/overview",
+                "capabilities/navigation/native-go2"


Navigation path doesn't match the existing file

capabilities/navigation/native-go2 references a file that doesn't exist. The actual file is docs/capabilities/navigation/native/index.md, which Mintlify would serve at the slug capabilities/navigation/native. Until the file is renamed or moved, this nav entry will 404.

greptile-apps · 2026-05-13T09:24:03Z

+                "usage/data_streams/overview",
+                "usage/data_streams/reactivex",
+                "usage/data_streams/advanced_streams",
+                "usage/data_streams/quality_filter",
+                "usage/data_streams/temporal_alignment",
+                "usage/data_streams/storage_replay"


overview sub-pages don't exist for Data Streams or Sensor Streams

Both usage/data_streams/overview and usage/sensor_streams/overview are listed in the nav, but neither overview.md nor overview.mdx exists in those directories — only README.md. Mintlify maps README.md to the directory-level slug (usage/data_streams), not to a child overview path. These entries will produce 404s. The same pattern repeats in the Sensor Streams group and in several other groups referencing overview pages that haven't been created yet.

greptile-apps · 2026-05-13T09:24:06Z

+      "light": "#1682a3",
+      "dark": "#1682a3"
+    },
+    "favicon": "/favicon.svg",


Referenced favicon.svg was not added

docs.json points to /favicon.svg but no such file exists in the docs/ directory or was included in this PR. Mintlify will display its own default favicon (or a broken icon) until this file is provided.

greptile-apps · 2026-05-13T09:24:09Z

+    "logo": {
+      "light": "/assets/dimensional-logo-master-transparent.png",
+      "dark": "/assets/dimensional-logo-master-transparent.png"
+    },


Same transparent logo for both light and dark themes

light and dark both point to the same transparent PNG. If the logo has dark-coloured text or elements, it will be invisible on a dark background, and vice versa. Consider supplying a white/inverted version for the dark key, or use an SVG logo that adapts via CSS currentColor.

greptile-apps · 2026-05-13T09:24:11Z

+          "pages": [
+  "platforms/quadruped-go2",
+            "platforms/humanoid-g1"
+          ]


Inconsistent indentation inside the Platforms pages array

platforms/quadruped-go2 is missing its leading spaces, making the array visually inconsistent and potentially confusing to future editors.

Suggested change

"pages": [

"platforms/quadruped-go2",

"platforms/humanoid-g1"

]

"pages": [

"platforms/quadruped-go2",

"platforms/humanoid-g1"

]

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

codecov · 2026-05-13T09:26:17Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

greptile-apps · 2026-05-13T16:14:04Z

+
+<Columns cols={2}>
+  <Card title="Navigation & mapping" icon="map" href="/capabilities/navigation/overview">
+    **SLAM**, dynamic obstacle avoidance, route planning, and autonomous exploration- via both DimOS native and ROS integrations.


Broken /capabilities/navigation/overview and /capabilities/memory/overview links

Neither capabilities/navigation/overview.md nor capabilities/memory/overview.md exists in the repository. The actual navigation file lives at capabilities/navigation/readme.md (nav slug capabilities/navigation/readme) and the memory landing page is capabilities/memory/index.md (nav slug capabilities/memory/index). Both card hrefs will 404 immediately in the live docs.

greptile-apps · 2026-05-13T16:14:05Z

+  <Card title="Quickstart" icon="rocket" href="/quickstart">
+    Install DimOS, run your first blueprint, and inspect the running system.
+  </Card>
+  <Card title="DimOS concepts" icon="diagram-project" href="/usage/concepts">


/usage/concepts links to a non-existent page

No file docs/usage/concepts.md or docs/usage/concepts.mdx exists anywhere in the repository, and there is no corresponding entry in the docs.json navigation. Any user who clicks the "DimOS concepts" card will land on a 404.

greptile-apps · 2026-05-13T16:14:06Z

+dimos run unitree-go2
+```
+
+Do not skip the platform guide - latency, time sync, and safety habits matter: [Unitree Go2](/platforms/quadruped-go2).


/platforms/quadruped-go2 slug doesn't match the actual file path

The file lives at docs/platforms/quadruped/go2/index.md, which Mintlify serves at platforms/quadruped/go2/index. The slug /platforms/quadruped-go2 used here (and again in the CardGroup below) has no matching file, so both links will 404. The docs.json nav already uses the correct nested path.

Suggested change

Do not skip the platform guide - latency, time sync, and safety habits matter: [Unitree Go2](/platforms/quadruped-go2).

Do not skip the platform guide - latency, time sync, and safety habits matter: [Unitree Go2](/platforms/quadruped/go2/index).

greptile-apps · 2026-05-13T17:36:12Z

+  <Card title="Capabilities" href="/capabilities/agents/readme" icon="bolt">
+    Navigation, perception, spatial memory, and manipulation.
+  </Card>


The "Capabilities" card duplicates the same href as the "Add an LLM agent" card directly above it — both point to /capabilities/agents/readme. The description ("Navigation, perception, spatial memory, and manipulation") clearly intends a broader capabilities landing page. Users clicking "Capabilities" will land on the Agents readme instead, which is confusing and makes one of the two cards redundant. A reasonable target would be /capabilities/navigation/readme (the first top-level capability page in the nav) or a dedicated capabilities overview if/when one is created.

Suggested change

<Card title="Capabilities" href="/capabilities/agents/readme" icon="bolt">

Navigation, perception, spatial memory, and manipulation.

</Card>

<Card title="Capabilities" href="/capabilities/navigation/readme" icon="bolt">

Navigation, perception, spatial memory, and manipulation.

</Card>

swstica added 4 commits May 13, 2026 14:33

add Dimensional logo asset

3ff7704

add docs.json for mintlify config

308a5a3

add introduction page

f10c081

add quickstart page

4d19290

greptile-apps Bot reviewed May 13, 2026

View reviewed changes

swstica mentioned this pull request May 13, 2026

Swastika/mint docs/mdx fixes #2075

Open

1 task

swstica added 3 commits May 13, 2026 21:38

fix greptile error: update docs config

03874d8

fix greptile error: remove troubleshooting

4ecf180

fix greptile error: add favicon asset

9d3fe55

greptile-apps Bot reviewed May 13, 2026

View reviewed changes

swstica and others added 2 commits May 13, 2026 22:02

fix greptile error: update file paths

69514a7

Merge branch 'main' into swastika/mint-docs/new-pages

98ddb16

greptile-apps Bot reviewed May 13, 2026

View reviewed changes

fix greptile error: remove duplicate path

c1b3b11

		First replay failing? Most issues are network or LFS related. See [Replay troubleshooting](/troubleshooting/replay).
		</Note>

	Do not skip the platform guide - latency, time sync, and safety habits matter: [Unitree Go2](/platforms/quadruped-go2).
	Do not skip the platform guide - latency, time sync, and safety habits matter: [Unitree Go2](/platforms/quadruped/go2/index).

Conversation

swstica commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

How to Test

Contributor License Agreement

Uh oh!

greptile-apps Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

swstica commented May 13, 2026 •

edited

Loading

greptile-apps Bot commented May 13, 2026 •

edited

Loading

codecov Bot commented May 13, 2026 •

edited

Loading