Skip to content

docs(readme): document project, design choices, testing and use of AI #40

Jump to bottom
Merged
merged 1 commit into from
Sep 19, 2026
Merged

docs(readme): document project, design choices, testing and use of AI #40

merged 1 commit into from
Sep 19, 2026
+96 −15

Conversation

ayushb
Copy link
Member

@ayushb ayushb commented Sep 18, 2026

Follow-up to #14

  • add project description, features, getting started and how to use the app
  • add project structure and deployment steps
  • explain design choices (MVC split, TanStack Query, localStorage vs sessionStorage, id-only sorting, plain CSS and accessibility)
  • list automated and manual testing (Mac and iPhone, Safari and Chrome)
  • add section on use of AI
  • fold the old "Useful commands" list into the commands table under Getting started

@ayushb
docs(readme): document project, design choices, testing and use of AI
6e75c90 
* Add project description, features, getting started and how to use
* Add project structure and deployment steps
* Explain the MVC split, TanStack Query usage and the storage choices
* List automated and manual testing
* Add section on use of AI

References #14
@ayushb ayushb requested a review from a team as a code owner September 18, 2026 23:09
@ayushb ayushb mentioned this pull request Sep 18, 2026
Merged
thomhet
thomhet approved these changes Sep 18, 2026
View reviewed changes
Copy link
Member

@thomhet thomhet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ayushb ayushb merged commit 044cc1b into main Sep 19, 2026
@ayushb ayushb deleted the docs/readme-choices-testing-ai branch September 19, 2026 08:47
Sign in to join this conversation on GitHub.
Reviewers

@thomhet thomhet thomhet approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ayushb @thomhet