Skip to content

docs: add MkDocs Material documentation site#1424

Open
TimChild wants to merge 1 commit intoruvnet:mainfrom
TimChild:feat/mkdocs-documentation
Open

docs: add MkDocs Material documentation site#1424
TimChild wants to merge 1 commit intoruvnet:mainfrom
TimChild:feat/mkdocs-documentation

Conversation

@TimChild
Copy link
Copy Markdown

Summary

Adds a complete MkDocs Material documentation site with 17 pages covering getting started, architecture, agents, MCP integration, and configuration. Includes a GitHub Actions workflow for automatic deployment to GitHub Pages.

What's included

  • 17 documentation pages organized into 6 sections (Home, Getting Started, Architecture, Agents, MCP, Configuration)
  • MkDocs Material theme with dark/light mode toggle, search, navigation tabs, and code copy buttons
  • mkdocs-llms-source plugin generating /llms.txt and /llms-full.txt following the llms.txt spec
  • GitHub Actions workflow (.github/workflows/docs.yml) for auto-deploy on push to main
  • docs-requirements.txt for reproducible builds
  • Mermaid diagram support for architecture visualizations

Structure

docs/
├── index.md                    # Homepage with quick start + comparison table
├── for-llms.md                 # Explains /llms.txt endpoints
├── getting-started/            # Installation, quickstart, Claude Code integration
├── architecture/               # Overview, swarm topologies, memory, routing, security
├── agents/                     # Catalog, swarm config, anti-drift
├── mcp/                        # Server, tools, client setup
└── configuration/              # Settings reference

Build verification

  • mkdocs build --strict passes with zero warnings
  • All 17 pages render correctly
  • Mermaid diagrams render properly
  • llms.txt and llms-full.txt both generate correctly

Screenshots

Homepage

Homepage

Architecture (with Mermaid diagrams)

Architecture

To deploy

After merging, enable GitHub Pages in the repo settings:
Settings → Pages → Source: GitHub Actions

The workflow will automatically build and deploy on every push to main.

Notes

  • The docs-screenshots/ directory is only for this PR preview and can be removed before or after merge
  • Content was drafted based on the existing README and codebase — happy to adjust any sections

- 17 pages covering getting started, architecture, agents, MCP, and configuration
- MkDocs Material theme with dark/light mode
- llms-source plugin generating /llms.txt and /llms-full.txt
- GitHub Actions workflow for auto-deploy to GitHub Pages
- docs-requirements.txt for reproducible builds
@TimChild TimChild force-pushed the feat/mkdocs-documentation branch from a260bcc to 31534a6 Compare March 24, 2026 15:51
@TimChild TimChild marked this pull request as ready for review March 24, 2026 15:52
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