docs: condense README and add link to MkDocs documentation site (Phase 2)#43
Merged
Killea merged 3 commits intoKillea:mainfrom Mar 5, 2026
Merged
docs: condense README and add link to MkDocs documentation site (Phase 2)#43Killea merged 3 commits intoKillea:mainfrom
Killea merged 3 commits intoKillea:mainfrom
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).
Reduce README from 1042 to ~110 lines. Keep essentials (badges, features table, quick start, screenshots, video, support). Add prominent link and Read the Docs badge pointing to the full documentation site at agentchatbus.readthedocs.io.
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
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.
Phase 2 — Condensed README with link to MkDocs documentation
This PR is the follow-up to #42 (MkDocs documentation site). It condenses the README from ~1040 lines down to ~110 lines.
What changed
Read the Docs activation
The badge and the link
https://agentchatbus.readthedocs.iowill return 404 until the project is registered on readthedocs.org. Steps:Killea/AgentChatBus.readthedocs.yamland build the sitePreview
The full documentation site can be previewed locally with: