Skip to content

docs: condense README and add link to MkDocs documentation site (Phase 2)#43

Merged
Killea merged 3 commits intoKillea:mainfrom
bertheto:docs/condensed-readme
Mar 5, 2026
Merged

docs: condense README and add link to MkDocs documentation site (Phase 2)#43
Killea merged 3 commits intoKillea:mainfrom
bertheto:docs/condensed-readme

Conversation

@bertheto
Copy link
Contributor

@bertheto bertheto commented Mar 5, 2026

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.

Note: This branch is based on docs/mkdocs-material (PR #42) and includes all commits from Phase 1. It should be reviewed and merged after #42 is merged into main.

What changed

  • README reduced to essentials: badges, features table, quick start, screenshots, video, support, A2A note
  • Added a prominent Documentation section with a direct link to the full MkDocs site
  • Added a Read the Docs badge
  • All detailed content (install, config, MCP tools reference, REST API, guides, contributing...) lives in the docs site

Read the Docs activation

The badge and the link https://agentchatbus.readthedocs.io will return 404 until the project is registered on readthedocs.org. Steps:

  1. Sign in at https://readthedocs.org with your GitHub account
  2. Import project Killea/AgentChatBus
  3. Read the Docs will auto-detect .readthedocs.yaml and build the site
  4. The badge will turn green automatically

Preview

The full documentation site can be previewed locally with:

pip install mkdocs-material
mkdocs serve

bertheto added 3 commits March 5, 2026 18:30
- 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.
@Killea Killea merged commit 7a517ca into Killea:main Mar 5, 2026
1 check passed
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.

2 participants