Fusion
875594d66d
- Add CommitPanel component for viewing changed files and committing - Show file status indicators (M/A/D/?) in file tree - Integrate git status with workspace for real-time updates - Add CSS styles for commit panel and status badges Part of git-control change implementation.
2.1 KiB
2.1 KiB
Documentation Overhaul
Problem
The project has grown significantly but documentation hasn't kept up:
- README is minimal: Only contains testing strategy, no project overview
- No feature documentation: Users can't discover what the app does
- No API docs: Developers have to read source code
- No deployment guide: Docker/Traefik setup is tribal knowledge
- No architecture docs: New contributors can't understand the codebase
- No user guide: Features like repo workspace, git history aren't explained
- OpenSpec changes aren't linked: Completed changes exist but aren't referenced
Solution
Create a comprehensive documentation system:
- Rewrite README: Project overview, features, quick start, architecture
- Create docs/ directory: Structured documentation
- Document all features: What exists and how to use it
- Create API documentation: Auto-generated + manual docs
- Create deployment guide: Docker, Traefik, Authentik setup
- Create architecture docs: Backend, frontend, data flow
- Create documentation templates: For future features
- Create CONTRIBUTING.md: How to add docs for new features
Benefits
- Onboarding: New developers understand the project in minutes
- Discovery: Users discover features they didn't know existed
- Maintenance: Architecture docs help refactoring decisions
- Deployment: Clear setup instructions reduce support burden
- Future-proof: Templates ensure new features get documented
Scope
What gets documented:
- All existing features (projects, repos, git history, workspace, auth, etc.)
- Architecture (backend, frontend, database, deployment)
- API endpoints
- Configuration options
- Development setup
What gets created:
- README.md (rewritten)
- docs/ directory with structured docs
- docs/templates/ for new features
- docs/api/ for API documentation
- docs/architecture/ for system design
- docs/deployment/ for setup guides
- docs/features/ for user guides
What stays:
- Testing strategy (moved to docs/testing.md)
- OpenSpec changes (archived as-is)