docs: complete documentation overhaul with auto-generated tool reference#7
Merged
Conversation
- Add replicator docs command: generates MCP tool reference from live registry (always in sync, 53 tools grouped by category) - Rewrite README: accurate status, badges, all 9 CLI commands, environment variables, MCP client config examples, mermaid architecture diagram, full package layout - Create docs/tools.md: auto-generated schemas + hand-written examples for hive_create, swarmmail_send, swarm_decompose, hivemind_store - Create CONTRIBUTING.md: dev setup, testing conventions, PR workflow - Create CHANGELOG.md: retroactive v0.1.0 and v0.2.0 entries
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
Addresses the documentation gap analysis: README was stuck at Phase 0 with 4 tools while the codebase has 53 tools across 5 completed phases.
New:
replicator docscommandAuto-generates a markdown tool reference from the live registry. Always in sync -- when tools are added or modified,
replicator docsreflects it immediately. 3 tests verify all 53 tools appear with correct category grouping.New:
docs/tools.md(1400+ lines)Complete MCP tool reference with schemas for all 53 tools + hand-written usage examples for 4 key tools (hive_create, swarmmail_send, swarm_decompose, hivemind_store).
Rewritten:
README.mdNew:
CONTRIBUTING.mdDev setup, testing conventions, PR workflow, coding standards.
New:
CHANGELOG.mdRetroactive v0.1.0 and v0.2.0 entries.