Skip to content

Revamp README with updated visuals and mobile compatibility - #70

Merged
Mahakisore7 merged 3 commits into
mainfrom
docs/readme-revamp
Oct 4, 2026
Merged

Mahakisore7 merged 3 commits into
mainfrom
docs/readme-revamp

Conversation

@Mahakisore7

Copy link
Copy Markdown
Member

Enhance the README by adding new screenshots, architecture diagrams, and tech stack visuals. Improve mobile compatibility for the weight chart and implement a testing setup for reproducible screenshots. Update documentation to reflect the correct license and fix broken links.

Mahakisore7 and others added 3 commits October 4, 2026 16:44
The axis was 36px wide and pulled 12px left, so quarter-kilo ticks such as
69.25 lost their first digits at phone width. Give it 44px and no negative
margin.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
scripts/readme-shots captures phone and desktop screens with realistic demo
data (a South Indian hostel menu) through the e2e servers; run it with
`pnpm exec playwright test -c playwright.readme.config.ts`. It is kept out of
the e2e run. signIn() gains optional displayName/email.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Hero banner with real app screens; light/dark architecture diagram and
  tech-stack board built by docs/assets/readme/generate.py from vendored
  techicons.dev (Devicon) and Simple Icons marks
- Screens gallery, feature grid, Mermaid flows for the optimizer and coach
  (checked against the chat router), testing and security sections
- Fix the license: the repo is Apache 2.0, not MIT
- Fix ADR links (the database row cited the monorepo ADR) and drop the
  phase-plan link that pointed outside the repository

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@Mahakisore7
Mahakisore7 merged commit ddb9931 into main Oct 4, 2026
2 of 3 checks passed
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