-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Labels
Feature RequestNew feature or requestNew feature or requestdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Create comprehensive developer documentation for contributors.
Files to Create
- CONTRIBUTING.md - Contribution guidelines
- ARCHITECTURE.md - Technical architecture deep-dive
- docs/api-reference.md - Expand current API docs
- docs/troubleshooting.md - Common issues and solutions
- docs/migration-guide.md - Version upgrade guides
CONTRIBUTING.md Should Include
- Code of conduct
- Development setup
- Coding standards
- Pull request process
- Testing requirements
- Documentation requirements
ARCHITECTURE.md Should Include
- System architecture diagram
- Component interactions
- Data flow
- Transport layer design
- Tool system architecture
- Configuration system
- Testing strategy
Tasks
- Create CONTRIBUTING.md
- Create ARCHITECTURE.md
- Expand docs/api-reference.md
- Create docs/troubleshooting.md
- Create docs/migration-guide.md
- Add architecture diagrams
- Link from main README
- Review by team
References
- Update existing CLAUDE.md as needed
- Complement existing documentation
Metadata
Metadata
Assignees
Labels
Feature RequestNew feature or requestNew feature or requestdocumentationImprovements or additions to documentationImprovements or additions to documentation