Skip to content

Add project README replacing Vite boilerplate - #62

Open
Nili-L wants to merge 5 commits into
mainfrom
readme-overhaul
Open

Add project README replacing Vite boilerplate#62
Nili-L wants to merge 5 commits into
mainfrom
readme-overhaul

Conversation

@Nili-L

@Nili-L Nili-L commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a proper README.md covering mission, Six Cs model, features, tech stack, and getting started
  • Replaces the generic Vite template README as the repo's primary entry point
  • Voice-reviewed for tone (direct, concrete, no marketing fluff)

What's in the README

  • Opening hook with problem/solution framing for crisis contexts (Israel, Ukraine, disaster zones)
  • Six Cs model table with purpose and examples
  • 8 key features (offline, NLP, adaptive conversation, a11y, companion mode, etc.)
  • Tech stack table
  • Clone-and-run getting started (4 lines)
  • Project structure overview
  • "Why this matters" section
  • Research foundation with published citations

Still needed (separate PRs)

  • Demo GIF or video
  • LICENSE file
  • Consolidate Docs/ and docs/ into one folder

🤖 Generated with Claude Code

Covers mission, Six Cs model, features, tech stack, getting started,
project structure, and research foundation. Replaces README-vite.md
as the repo's primary documentation entry point.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Nili-L
Nili-L had a problem deploying to calme-app-staging April 9, 2026 12:30 — with GitHub Actions Failure
Cherry-picked from alt README review: scannable "Why different" bullets
at top, visible demo placeholder, and architecture as its own section
above the tech stack table.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Nili-L
Nili-L had a problem deploying to calme-app-staging April 9, 2026 12:59 — with GitHub Actions Failure
- Problem section: Oct 7 stats (21% anxiety, 1.3% treated) with sources
- Six Cs table: Hebrew name MA'ASEH added
- Accessibility: upgraded to WCAG 2.2 target, speech-to-text planned
- Team section: six members with disciplines listed

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Nili-L
Nili-L had a problem deploying to calme-app-staging April 9, 2026 13:07 — with GitHub Actions Failure
- docs/target-populations.md: immigrants, disabilities, caregivers,
  with accessibility statistics and State Comptroller findings
- docs/impact-analysis.md: economic cost (4B NIS), expected impact,
  global scalability case
- docs/ROADMAP.md: structured future milestones (LLM integration,
  accessibility, platform integration, UI)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Nili-L
Nili-L had a problem deploying to calme-app-staging April 9, 2026 13:09 — with GitHub Actions Failure
- Migrate all Docs/ files to docs/ with clean lowercase names
- Delete orphaned ProfileIntro.tsx/css and Retired/ deprecated files
- Update .oxlintrc.json ignore path from Docs/** to docs/**
- Add CONTRIBUTING.md with setup, workflow, and content review policy
- Add GitHub issue templates (bug report, feature request)
- Add pull request template with offline/a11y/lint checklist

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Nili-L
Nili-L had a problem deploying to calme-app-staging April 9, 2026 13:22 — with GitHub Actions Failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant