-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
infrastructureDevOps & infrastructureDevOps & infrastructurepriority-mediumMedium priorityMedium priority
Description
Summary
Create comprehensive documentation for users and contributors.
README Sections
- Project description and value prop
- Screenshots/GIFs showing key flows
- Feature list
- Tech stack
- Getting started (local development)
- Environment variables
- Testing instructions
- Deployment guide
- Contributing guidelines
- License
Additional Docs
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
- Architecture overview
- API documentation (if applicable)
- Self-hosting guide
README Header
```markdown
Estim
Async sprint estimation for remote teams.
Cut your planning meetings from 3 hours to 30 minutes.
Features • Getting Started • Documentation
Acceptance Criteria
- README clearly explains the product
- New contributors can set up locally
- Screenshots show the app in action
- All setup steps documented
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
infrastructureDevOps & infrastructureDevOps & infrastructurepriority-mediumMedium priorityMedium priority
