-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
area: docsDocumentation (README, API docs, guides)Documentation (README, API docs, guides)documentationImprovements or additions to documentationImprovements or additions to documentationpriority: mediumNormal priorityNormal prioritystatus: in-progressIssue actively being worked onIssue actively being worked on
Milestone
Description
Overview
This issue tracks the cleanup and reorganization of documentation files in the repository.
Tasks
1. Audit and Remove Temporary Files
- Remove any temporary markdown files that are no longer needed
- Clean up any development notes or POC files
- Keep only essential documentation
2. Reorganize Documentation Structure
- Keep only README.md and CLAUDE.md in root directory
- Move all developer documentation to
docs/development/or similar folder - Create proper folder structure under docs for different types of documentation
3. Update GitHub Identity Management Docs
- Document the pattern of using personal identity for commits + bot identity for PRs
- Explain benefits: contribution credit + ability to review own PRs
- Make it clear this is optional but recommended
- Include setup instructions for those who want to use this pattern
4. Create Development Workflow Documentation
- Document the TDD workflow
- Include code quality standards
- Add testing requirements
- Document the demo deployment process (link to demo-router-worker repo)
5. Files to Move/Update
- GITHUB_IDENTITY_MANAGEMENT.md → docs/development/github-identity.md
- DEVELOPMENT_WORKFLOW.md → docs/development/workflow.md
- DEMO-DEPLOYMENT.md → docs/development/deployment.md
- Any other developer-focused docs
Acceptance Criteria
- Root directory only contains: README.md, CLAUDE.md, CLAUDE.personal.md (gitignored), and necessary config files
- All developer documentation is organized under docs/
- Documentation is clear, concise, and actionable
- No temporary or outdated files remain
Metadata
Metadata
Assignees
Labels
area: docsDocumentation (README, API docs, guides)Documentation (README, API docs, guides)documentationImprovements or additions to documentationImprovements or additions to documentationpriority: mediumNormal priorityNormal prioritystatus: in-progressIssue actively being worked onIssue actively being worked on
Projects
Status
📥 Needs Triage