Skip to content

Documentation and README #29

@elias-ba

Description

@elias-ba

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.

CI
License: MIT

FeaturesGetting StartedDocumentation

Estim Screenshot
```

Acceptance Criteria

  • README clearly explains the product
  • New contributors can set up locally
  • Screenshots show the app in action
  • All setup steps documented

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions