📝 Clarify Node/pnpm setup and mark Docker optional in the README - #4972
Open
isaaclombardssw wants to merge 1 commit into
Open
📝 Clarify Node/pnpm setup and mark Docker optional in the README#4972isaaclombardssw wants to merge 1 commit into
isaaclombardssw wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VRcoUyMuvLA51GPLK1Bdwo
Contributor
Coverage report
Test suite run success27 tests passing in 3 suites. Report generated by 🧪jest coverage report action from 9f94b91 |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s getting-started documentation to make the local Node/pnpm setup explicit and to clarify that Docker is optional for day-to-day development.
Changes:
- Update Node requirement text to reference the version pinned in
.nvmrcand addnvm useto the setup steps. - Add explicit pnpm setup via Corepack before running
pnpm install. - Mark the Docker build section as optional and explain when it’s useful; clarify why
pnpm devresults in multiple localhost ports.
Suppressed comments (1)
README.md:36
- The sentence "Both are one-off" is misleading:
corepack enable pnpmis typically one-time per machine/user, butnvm usegenerally needs to be run whenever the current shell isn't already using the.nvmrcversion (often each new terminal session). Reword to avoid implyingnvm useis a one-time setup.
Select the pinned Node version and enable pnpm. Both are one-off, and Corepack ships with Node:
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+30
to
32
| - Git, and the Node.js version pinned in [`.nvmrc`](.nvmrc) (currently v24.13.1). `nvm use` picks it up automatically. | ||
| - pnpm `corepack enable pnpm` | ||
| - A [TinaCMS](https://app.tina.io) account for live editing. |
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.
README-only change to the getting-started steps.
Affected routes: none (docs only)
No linked issue -
no-issuelabel applied, per its description ("used to bypass the PR-Lint check. Should be used for non-coding changes")Changes:
Node version was vague. Requirements said "Node.js Active LTS", which doesn't match the repo -
.nvmrcpins v24.13.1. Now points at.nvmrcwith the concrete version and mentionsnvm use.pnpm appeared from nowhere.
pnpm installwas the first command with no explanation of wherepnpmcomes from. Addednvm use+corepack enable pnpmas one-off setup. Corepack readspnpm@10.25.0from thepackageManagerfield, so nobody has to choose a version.Docker read as required. It sits between the local steps and the Dev Container section with no indication it's optional. Heading is now "(optional)", with one sentence on when it is the right tool (reproducing the deployed container) so it doesn't read as discouraging it.
Noted that
pnpm devstarts Next.js and the local Tina server together, since the localhost list further down shows ports 3000 and 4001 without saying why there are two.If adding a new page, I have followed the 📃 New Webpage issue template
If updating the livestream banner, I have tested and followed the steps in Wiki - Testing the live banner
Include Done Video or screenshots - n/a, the diff is the change (README only)