Repository navigation
docs: restructure readme - #35
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Summary
The README had grown by accretion over this week's changes — a one-note "Dependencies" section
wedged between Getting Started and Database, lint and formatting docs buried under a "Tests"
heading, and a lot of prose explaining why a change was made rather than what a reader needs.
Restructured around what someone actually needs, in the order they need it:
Two things were missing entirely
ENABLE_EXPERIMENTAL_COREPACK=1was documented nowhere — only in #21's description. It isset on Production and Preview, and removing it breaks deploys: Vercel would fall back to
pnpm 9, which rejects a
pnpm-workspace.yamlwith nopackages:field, failing withERROR packages field missing or empty. That is now its own section.There was no Deployment section at all — the original
## Deploy on Vercelwascreate-next-appboilerplate and I deleted it earlier while rewriting. The repo has realdeploy requirements now, so it is back with actual content.
Added
and a table of which paths are protected, public, or middleware-only. The
clerkMiddleware()-protects-nothing trap is stated, since that is what caused the authregression.
while the secret key is an instance admin credential.
unstable_cachenever-trust-a-miss behaviour, which is otherwise only visible as acomment in the route.
Trimmed
Migration history — "ESLint was kept briefly, then dropped" and similar. That belongs in PR
descriptions, not a README. The consequence is kept: the oxlint known-gap list, because it
tells you what is not caught.
Verified, not remembered
Every factual claim was checked against the code rather than written from memory:
runtime = "edge"createRouteMatcher(["/"])is the protected set/api/healthis outside the proxy matcherpnpm-workspace.yamlhas nopackages:fieldlint,format:check,test:unit,test:e2eand the buildThat last one caught an error of mine: I had written "CI runs all five", but
pnpm formatisthe write variant and CI cannot run it. Corrected.
ENABLE_EXPERIMENTAL_COREPACKwas confirmed still present on both environments viavercel env lsbefore documenting it as required.