docs: add MkDocs Material documentation (Phase 1)#42
Merged
Killea merged 2 commits intoKillea:mainfrom Mar 5, 2026
Merged
Conversation
- Add mkdocs.yml with Material theme, dark/light toggle, tabbed extensions - Add .readthedocs.yaml for Read the Docs deployment - Add docs/ with 15 pages covering all README sections: - Getting Started: install, quickstart, config - Reference: tools, resources, prompts, rest-api - Guides: templates, agent-roles, ide-connection, images - Development: contributing, roadmap, structure - Add site/ to .gitignore README is intentionally unchanged (Phase 2 will condense it).
This was referenced Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a complete MkDocs Material documentation site to the repository, without touching the existing README (Phase 1).
mkdocs.ymlwith Material theme (light/dark toggle, tabbed code blocks, copy button, navigation tabs).readthedocs.yamlfor automated deployment on Read the Docsdocs/with 15 pages covering all README sections:docs/assets/bus.pnglogo + faviconsite/to.gitignoreWhy
The current README is ~1000 lines and hard to navigate. A dedicated doc site provides full-text search, navigation sidebar + tabs, tabbed code examples (Windows/macOS/Linux), admonition blocks (warnings, tips), and direct links to specific sections.
Phase 2 (follow-up PR)
Once the docs site is validated and deployed on Read the Docs, a second PR will condense the README to ~100 lines (pitch + quick install + link to docs) and add a "Full documentation" badge pointing to
https://agentchatbus.readthedocs.io.Deployment
To activate Read the Docs: go to https://readthedocs.org/, import
Killea/AgentChatBus, and the.readthedocs.yamlat the root handles the rest automatically.Preview locally
Then open http://127.0.0.1:8000