Docs: restructure Readme with centralized index + v0.4.0 upcoming features & implementation patterns#70
Merged
Conversation
- Slim README from 1079 to 253 lines (~76% reduction) - Add documentation hub table linking to all docs - Create docs/COMMANDS.md - complete CLI reference - Create docs/CONFIGURATION.md - config options reference - Create docs/TROUBLESHOOTING.md - common issues guide - Create STANDALONE_DEPLOYMENT.md - offline/simulation guide - Create LICENSE (MIT) and CODE_OF_CONDUCT.md - Update GETTING_STARTED.md with enhanced TUI section - Remove broken links (quickstart.md, RESOURCE_MONITORING.md) - Update CLAUDE.md imports and file structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
gudzenkov
force-pushed
the
chore/doc-pages-restructure
branch
from
20928ca to
1a7ea79
Compare
Create three-document architecture for clean separation:
1. CLAUDE.md - Current v0.3.8 development guide
- Added pointer to UPCOMING_FEATURES.md
- Keeps implementation status table
- Focuses on working features
2. docs/UPCOMING_FEATURES.md - NEW v0.4.0 patterns guide
- Documents 6 major implementation patterns:
* Hook System Integration (code exists, not integrated)
* Verification Agent Pattern (code exists, not integrated)
* DynamicSpawner (code exists, not integrated)
* Parallel Execution (code exists, not integrated)
* ai-session integration (documented, not implemented)
* IPC & Daemon Mode (documented, not functional)
- Includes code examples, file locations, integration TODOs
- Based on docs/ARCHITECTURE.md and gap analysis
3. README.md - Public overview
- Added 'In Development (v0.4.0)' section
- Links to UPCOMING_FEATURES.md for details
- Lists 6 major features with status markers
Benefits:
- Claude knows what's working (CLAUDE.md) vs upcoming (UPCOMING_FEATURES.md)
- No confusion about feature status
- Implementation patterns preserved from removed v0.4.0 docs
- v0.5.0 candidates identified (multi-provider ACP only)
All v0.4.0 features are gap fixes from docs/analysis/, not new capabilities.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Mark ACP module as stub implementation and document actual execution model: - README.md: Update implementation status to show AI execution is simulated - README.md: Change multi-provider integration from "Working" to "Planned" - README.md: Update architecture diagram to reflect simulated execution - docs/CLAUDE_ACP.md: Add warning banner showing stub status - docs/UPCOMING_FEATURES.md: Add Section 5 (Provider Integration gaps) - docs/UPCOMING_FEATURES.md: Add Section 6 (ACP Integration stub details) Users can now understand that ccswarm v0.3.8 uses keyword-based simulated responses and that the provider system exists but is not integrated with the orchestrator. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
gudzenkov
force-pushed
the
chore/doc-pages-restructure
branch
from
1a7ea79 to
f44052c
Compare
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
Restructures documentation with clean separation between current v0.3.8 features and upcoming v0.4.0 implementation patterns.
Changes
1. Centralized Documentation Index (76% README reduction)
docs/COMMANDS.md- Complete CLI referencedocs/CONFIGURATION.md- All configuration optionsdocs/TROUBLESHOOTING.md- Common issues guideSTANDALONE_DEPLOYMENT.md- Offline/simulation guideLICENSE(MIT) andCODE_OF_CONDUCT.md2. v0.4.0 Implementation Patterns Documentation
docs/UPCOMING_FEATURES.md(616 lines)src/hooks/)src/orchestrator/verification.rs)src/subagent/spawner.rs)src/subagent/parallel_executor.rs)docs/ARCHITECTURE.mdand gap analysis3. Three-Tier Documentation Structure
Based On
docs/ARCHITECTURE.md(documents all v0.4.0 features)docs/analysis/00-capability-gap-analysis.mddocs/analysis/01-multi-agent-architecture-comparison.md