feat: add the remaining skeleton directories with READMEs - #8
Merged
Conversation
The data-layer directories were documented but absent, so the docs had to hedge every reference to them and a new app still started by guessing. Adds api/, constants/, hooks/, models/, services/, stores/ and utils/, each carrying a README that states what belongs there and what does not — the never-hand-edit rule sits in models/, the four hook conventions in hooks/, the store-before-context rule in stores/. No working code: this is the shape, not an implementation. Both reference docs are updated to say exactly that rather than describing directories that were not there. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
This was meant to be part of #6 but missed the merge — #6 landed before I pushed the commit, so master has the reference docs without the directories they describe. Cherry-picked onto current master.
What it adds
api/,constants/,hooks/,models/,services/,stores/andutils/— each with a README stating what belongs there and what does not. The never-hand-edit rule sits inmodels/, the four hook conventions inhooks/, the store-before-context rule instores/.No working code. This is the shape, not an implementation.
Why it matters for the docs
Without it,
frontend-architecture.mdhas to hedge every data-layer sentence — "not in this starter" — and a new app still opens a blanksrc/and guesses. With the directories present, the docs describe what is actually there. This PR updates both files accordingly.Two hedges remain and are correct:
src/routes.tsandsrc/routing/genuinely aren't here, because this starter declares routes inline inApp.tsx— a legitimate end state at this size, which the doc says explicitly.🤖 Generated with Claude Code