Skip to content

docs: add Sphinx documentation renderer#3104

Draft
TomCC7 wants to merge 5 commits into
mainfrom
docs/sphinx-render
Draft

docs: add Sphinx documentation renderer#3104
TomCC7 wants to merge 5 commits into
mainfrom
docs/sphinx-render

Conversation

@TomCC7

@TomCC7 TomCC7 commented Jul 21, 2026

Copy link
Copy Markdown
Member

Summary

  • render the existing documentation corpus with Sphinx, MyST, and the Furo theme
  • serve the existing Introduction content at /, while retaining /introduction/ as a compatibility route
  • use native Sphinx wrappers for canonical folder routes and hierarchical catalog navigation; align Usage with the Manipulation catalog
  • rename the legacy usage/index.md title from “Concepts” to “Usage” so the source and catalog agree
  • repair directory-style Sphinx search results so nested pages resolve from the site root
  • add a Dimensional-styled shell and strict documentation build in CI

Preview locally

git lfs pull --include="docs/**" --exclude=""
uv run --no-sync sphinx-build -E -W --keep-going -b html docs /tmp/dimos-sphinx-final
uv run --no-sync python -m http.server --directory /tmp/dimos-sphinx-final 8000

Open http://127.0.0.1:8000/.

Validation

  • git lfs pull --include="docs/**" --exclude="" && uv run --no-sync sphinx-build -E -W --keep-going -b html docs /tmp/dimos-sphinx-search-verified
  • search result links from /search/ resolve to their canonical root routes, including /capabilities/manipulation/
  • root output contains the existing Welcome to Dimensional content
  • Usage catalog has no visible usage/index leaf; nested stream guides remain under their wrapper pages
  • git diff --check
  • uv lock --check

@mintlify

mintlify Bot commented Jul 21, 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 21, 2026, 1:13 AM

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

@codecov

codecov Bot commented Jul 21, 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    #3104   +/-   ##
=======================================
  Coverage   72.56%   72.56%           
=======================================
  Files        1025     1025           
  Lines       92256    92256           
  Branches     8425     8425           
=======================================
+ Hits        66941    66944    +3     
+ Misses      23013    23011    -2     
+ Partials     2302     2301    -1     
Flag Coverage Δ
OS-ubuntu-24.04-arm 65.63% <ø> (+<0.01%) ⬆️
OS-ubuntu-latest 67.96% <ø> (-0.01%) ⬇️
Py-3.10 67.95% <ø> (-0.01%) ⬇️
Py-3.11 67.96% <ø> (+<0.01%) ⬆️
Py-3.12 67.96% <ø> (+<0.01%) ⬆️
Py-3.13 67.96% <ø> (-0.01%) ⬇️
Py-3.14 67.96% <ø> (-0.01%) ⬇️
Py-3.14t 67.96% <ø> (+<0.01%) ⬆️
SelfHosted-Large 30.08% <ø> (+<0.01%) ⬆️
SelfHosted-Linux 37.32% <ø> (ø)
SelfHosted-macOS 36.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 3 files 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant