Skip to content

feat: Create complete user and contributor documentation for Team Standup Tracker

Issue Description

The repository needs clear, project-specific documentation for both end users and contributors. Current docs are either incomplete, inconsistent, or not fully aligned with actual application behavior.

This issue covers creating and aligning documentation across user-facing and developer-facing files.

Scope

  • Add a complete user manual for the application workflow.
  • Ensure the manual covers:
    • setup and configuration
    • login and dashboard usage
    • intern/team/status workflows
    • CSV seed formats
    • verification rules
    • API endpoints used by the app
    • troubleshooting and FAQ
  • Link the user manual from README.md.
  • Update CONTRIBUTING.md to reflect current commands and workflow.
  • Update CHANGELOG.md under [Unreleased] with doc-related entries.
  • Keep only the user manual inside docs/; other docs remain at repo root.

Acceptance Criteria

  • docs/USER_MANUAL.md exists and is complete.
  • README.md includes a clear link to the user manual.
  • CONTRIBUTING.md is structured and accurate (including npx tsc -b for type-checking).
  • CHANGELOG.md has unreleased entries for these documentation updates.
  • docs/ contains only USER_MANUAL.md.

Out of Scope

  • Functional/code changes to app behavior.
  • Backend API changes.
  • UI redesign.