Swastika/docs/mintlify setup#2057
Conversation
Greptile SummaryThis PR bootstraps the Mintlify documentation site for dimos by adding
Confidence Score: 3/5The docs site will deploy with broken links and missing logo/favicon assets visible on every page. humanoid-g1.mdx links directly to capabilities/navigation/readme.md, a file deleted in this same PR, guaranteeing a 404 the moment the site is live. The stale /docs/…md link pattern was not fully remediated across the two new platform pages. docs/platforms/humanoid-g1.mdx and docs/platforms/quadruped-go2.mdx need all internal links corrected; docs/docs.json needs the logo and favicon asset files added before deploy. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
root["docs.json (Mintlify config)"]
root --> GS["Getting Started"]
root --> U["Usage"]
root --> C["Capabilities"]
root --> P["Platforms"]
root --> D["Development"]
root --> A["For Agents"]
GS --> intro["introduction.mdx"]
GS --> qs["quickstart.mdx ⚠️ broken /troubleshooting/replay"]
GS --> req["requirements.mdx"]
GS --> inst["Installation (ubuntu / osx / nix)"]
U --> concepts["concepts.mdx ⚠️ stale links"]
U --> modules["modules.mdx ⚠️ stale links"]
U --> blueprints["blueprints.mdx"]
U --> cli["cli.mdx ⚠️ stale links"]
U --> ds["Data Streams"]
U --> ss["Sensor Streams"]
U --> tr["Transports"]
C --> nav["Navigation"]
nav --> navoverview["overview.mdx ⚠️ stale links"]
nav --> nativego2["native-go2.mdx"]
C --> manip["Manipulation"]
C --> mem["Memory"]
C --> perc["perception.mdx"]
P --> go2["quadruped-go2.mdx ⚠️ stale links"]
P --> g1["humanoid-g1.mdx ⚠️ link to deleted readme.md"]
D --> docker["docker.mdx"]
D --> testing["testing.mdx"]
A --> aoverview["agents/overview.mdx"]
A --> adocs["agents/docs (codeblocks / doclinks)"]
root -. "⚠️ missing assets" .-> assets["/logo/light.svg\n/logo/dark.svg\n/favicon.svg"]
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| <Note> | ||
| First replay failing? Most issues are network or LFS related. See [Replay troubleshooting](/troubleshooting/replay). | ||
| </Note> |
There was a problem hiding this comment.
The <Note> block links to /troubleshooting/replay, but no such page exists in the repository or in the docs.json navigation. Clicking this link will result in a 404 on the deployed docs site.
| "logo": { | ||
| "light": "/logo/light.svg", | ||
| "dark": "/logo/dark.svg" | ||
| }, |
There was a problem hiding this comment.
docs.json references /logo/light.svg, /logo/dark.svg, and /favicon.svg, but none of these files exist in the repository. Every page on the deployed site will show a broken logo and favicon.
| "pages": [ | ||
| "platforms/quadruped-go2", | ||
| "platforms/humanoid-g1" | ||
| ] |
There was a problem hiding this comment.
"platforms/quadruped-go2" is at column 0 while the sibling entry "platforms/humanoid-g1" is properly indented. This is likely a copy-paste artefact.
| "pages": [ | |
| "platforms/quadruped-go2", | |
| "platforms/humanoid-g1" | |
| ] | |
| "pages": [ | |
| "platforms/quadruped-go2", | |
| "platforms/humanoid-g1" | |
| ] |
swstica
force-pushed
the
swastika/docs/mintlify-setup
branch
from
55aee28 to
02abdbf
Compare
|
1 participant
Problem
Docs folder was not set up for Mintlify deployment. No docs.json config existed, markdown files had MDX parsing errors, and introduction or quickstart pages were missing.
Solution
![img]()→<img />, blank lines around<details>blocks, escaped angle brackets)How to Test
npm i -g mintlify
mintlify dev
Contributor License Agreement