Repository navigation
docs(repo): rewrite the README around the article - #14
Merged
Merged
Conversation
5 tasks done
arnaud-zg
force-pushed
the
docs/readme-rewrite
branch
from
September 2, 2026 09:58
9733b51 to
c47c5d7
Compare
arnaud-zg
changed the base branch from
feat/wow-catalog-and-courier
to
feat/dev-settings-storage-switch
September 2, 2026 09:59
5 tasks done
The README was still the create-tanstack-app scaffold: Bun-only commands, src/routes instead of src/app/routes, a Shadcn CLI snippet, React Query floated as an option nothing uses. None of it matched the repo CONTRIBUTING.md and the article both describe. Rewritten around what the repo actually is: the Object Calisthenics rules with file pointers, an architecture diagram, a cart add-to-cart sequence diagram, the i18n and prerender setup from the last two PRs, and pnpm-first commands with the Bun equivalent kept. Deeper testing trophy and TDD notes stay in CONTRIBUTING.md rather than duplicated here. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014BcGPRc3sgUJYKihGRXh5g
Adds docs/architecture.md, styled after migration-preflight's docs: a fast, code-snippet-heavy map of why this repo exists and how an immutable domain class becomes React state, linked from the README next to the existing rule checklist. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DKueHPbWB1CdGYrghjsXJa
arnaud-zg
force-pushed
the
docs/readme-rewrite
branch
from
September 2, 2026 18:44
c47c5d7 to
48cac9d
Compare
This was referenced Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #13.
Summary
src/routesinstead of
src/app/routes, a Shadcn CLI snippet, React Query floated as an optionnothing uses
pointers, an architecture diagram, an add-to-cart sequence diagram, the i18n and
prerender setup, pnpm-first commands with the Bun equivalent kept
CONTRIBUTING.md, README links to itinstead of duplicating
docs/architecture.md, styled aftermigration-preflight's
docs: a fast, code-snippet-heavy map of why this repo exists and how an immutable
domain class becomes React state (
Cart+useImmutableInstance), linked from theREADME next to the rule checklist
Test plan
pnpm lint:mdpnpm typecheckpnpm check🤖 Generated with Claude Code
https://claude.ai/code/session_014BcGPRc3sgUJYKihGRXh5g