Skip to content

Mintlify compatibility#52

Merged
b-Tomas merged 4 commits into
mainfrom
b-Tomas/mintlify-docs
Dec 22, 2025
Merged

Mintlify compatibility#52
b-Tomas merged 4 commits into
mainfrom
b-Tomas/mintlify-docs

Conversation

@b-Tomas

@b-Tomas b-Tomas commented Dec 18, 2025

Copy link
Copy Markdown
Member

Description

Reduce the docs to common syntax for Sphinx and Mintlify, enabling a mintlify mutlirepo while maintaining the Sphinx site.

See inorbit-ai/docs#1


Note

Ports docs to shared Markdown content for Sphinx and Mintlify, adds Mintlify builder/navigation, restructures Sphinx, and updates CI to build from the new path.

  • Documentation:
    • Portable content: New shared docs under docs/contents using YAML frontmatter; internal links converted to Markdown links.
    • Sphinx restructure: Source moved to docs/sphinx with wrapper pages that {include} shared content; conf.py reads version without importing, updates static paths, sets root_doc, and suppresses MyST anchor warnings; Makefile gains serve target.
  • Mintlify:
    • Navigation: Adds docs/contents/docs.json for site navigation.
    • Build tooling: Adds docs/mintlify/build.py and Makefile to emit Mintlify-compatible output with absolute routes.
  • CI/CD:
    • Pages workflow: sphinx-build path switched to docs/sphinx and artifact path updated to docs/sphinx/_build/html in .github/workflows/docs.yaml.
  • Repo housekeeping:
    • .gitignore updated to ignore docs/*/_build/.
    • REUSE.toml extended to annotate new docs and build files.
    • CONTRIBUTING.md updated with new build/serve paths and commands.

Written by Cursor Bugbot for commit bd43c2d. This will update automatically on new commits. Configure here.

@b-Tomas b-Tomas self-assigned this Dec 18, 2025
@b-Tomas b-Tomas added the documentation Improvements or additions to documentation label Dec 18, 2025
Base automatically changed from b-Tomas/update-docs to main December 19, 2025 13:07
…bility

- Added new Sphinx documentation files and configuration for improved organization.
- Updated `.gitignore` to exclude Sphinx build directories.
- Modified `CONTRIBUTING.md` and GitHub Actions workflow to reflect new documentation paths.
- Introduced new content files for configuration, getting started, usage, and specification sections.
- Enhanced command handling documentation and added examples for single-robot and fleet connectors.
- Included static assets such as logos and favicons for documentation branding.
@b-Tomas
b-Tomas force-pushed the b-Tomas/mintlify-docs branch from 1a3d2f0 to bd43c2d Compare December 19, 2025 13:10
@b-Tomas
b-Tomas merged commit b276a37 into main Dec 22, 2025
14 checks passed
@b-Tomas
b-Tomas deleted the b-Tomas/mintlify-docs branch December 22, 2025 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants