Skip to content

Swastika/docs chore/cleanup and fix links#2832

Open
swstica wants to merge 4 commits into
mainfrom
swastika/docs-chore/link-redirect
Open

Swastika/docs chore/cleanup and fix links#2832
swstica wants to merge 4 commits into
mainfrom
swastika/docs-chore/link-redirect

Conversation

@swstica

@swstica swstica commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Problem

Docs use relative links which render on GitHub but 404 on Mintlify. A full link sweep also found a few broken links and image on the transports page.

Solution

  • Add redirects to docs.json: /docs/<page>.md → rendered page for every nav page, and /dimos, /examples, /bin, /docker, /misc, /.github, /AGENTS.md → GitHub blobs. No change to how we write links.
  • Fix broken links: quickstart (full GitHub URLs → repo paths), cli.md (link style), lcm.md (renamed dimos-lcm dirs).
  • Transports page: single diagram embed with corrected path.
  • Mintlify theme update.

swstica and others added 2 commits July 9, 2026 10:31
Map /docs/<page>.md links to their rendered pages, and /dimos,
/examples, /bin, /docker, /misc, /.github and /AGENTS.md source
paths to GitHub blobs, so repo-style links resolve on the
published site instead of 404ing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
dimensional 🟢 Ready View Preview Jul 9, 2026, 5:28 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@greptile-apps

greptile-apps Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes docs link rot by adding a comprehensive redirect layer in docs.json that maps /docs/<page>.md-style paths (the relative links that render on GitHub) to their Mintlify-rendered equivalents, plus GitHub-blob redirects for repo subtrees. Several broken links are also repaired inline.

  • docs.json: Adds ~100 redirect rules covering every nav page and top-level repo directory; removes the "Coding agents" nav group from the sidebar (pages remain accessible via direct link); upgrades Mintlify theme from mint to aspen.
  • quickstart.mdx / cli.md / lcm.md: Replaces raw GitHub blob URLs with redirect-compatible repo-relative paths; fixes two stale directory names in the external dimos-lcm repo (generated/csharpgenerated/cs_lcm_msgs, generated/javagenerated/java_lcm_msgs).
  • transports/index.md: Removes five duplicate ![output] embeds and corrects the image path from assets/ (missing one ../ level) to ../assets/, which now correctly resolves to the existing docs/usage/assets/abstraction_layers.svg.

Confidence Score: 5/5

Safe to merge — all changes are documentation and redirect configuration with no impact on runtime code.

The PR is limited to docs config, markdown content, and redirect rules. The redirect ordering is correct (specific rules before the /docs/:slug* catch-all), the fixed image path resolves to a confirmed existing asset, the broken link corrections are straightforward, and no runtime behaviour is touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/docs.json Adds ~100 redirect rules mapping GitHub-relative markdown paths to Mintlify routes; removes the "Coding agents" nav group; bumps theme to "aspen". Redirect ordering is correct — specific rules precede the catch-all /docs/:slug*.
docs/quickstart.mdx Replaces five full GitHub blob URLs with redirect-compatible repo-relative paths; all target redirects are present in docs.json.
docs/usage/cli.md Changes the GlobalConfig link from a direct Mintlify path to a redirect-dependent path — covered by a corresponding redirect in docs.json so it resolves correctly.
docs/usage/lcm.md Fixes two stale external GitHub links to renamed directories in the dimos-lcm repo.
docs/usage/transports/index.md Removes five duplicate image embeds and corrects the SVG path to ../assets/abstraction_layers.svg, which resolves correctly to the existing asset.

Reviews (2): Last reviewed commit: "theme change" | Re-trigger Greptile

Comment thread docs/usage/cli.md
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

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

@@           Coverage Diff            @@
##             main    #2832    +/-   ##
========================================
  Coverage   71.91%   71.92%            
========================================
  Files         979      979            
  Lines       87346    87346            
  Branches     7982     8116   +134     
========================================
+ Hits        62819    62820     +1     
  Misses      22387    22387            
+ Partials     2140     2139     -1     
Flag Coverage Δ
OS-ubuntu-24.04-arm 64.57% <ø> (-0.01%) ⬇️
OS-ubuntu-latest 67.05% <ø> (ø)
Py-3.10 67.04% <ø> (-0.01%) ⬇️
Py-3.11 67.04% <ø> (ø)
Py-3.12 67.05% <ø> (+<0.01%) ⬆️
Py-3.13 67.05% <ø> (+<0.01%) ⬆️
Py-3.14 67.05% <ø> (-0.02%) ⬇️
Py-3.14t 67.04% <ø> (-0.01%) ⬇️
SelfHosted-Large 30.10% <ø> (ø)
SelfHosted-Linux 37.66% <ø> (ø)
SelfHosted-macOS 36.02% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@swstica swstica changed the title Swastika/docs chore/link redirect Swastika/docs chore/cleanup and fix links Jul 9, 2026
@github-actions github-actions Bot added the ready-to-merge Required CI checks have passed on this PR label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Required CI checks have passed on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant