Skip to content

📝 Clarify Node/pnpm setup and mark Docker optional in the README - #4972

Open
isaaclombardssw wants to merge 1 commit into
mainfrom
docs/readme-docker-optional
Open

📝 Clarify Node/pnpm setup and mark Docker optional in the README#4972
isaaclombardssw wants to merge 1 commit into
mainfrom
docs/readme-docker-optional

Conversation

@isaaclombardssw

Copy link
Copy Markdown
Member

README-only change to the getting-started steps.

  • Affected routes: none (docs only)

  • No linked issue - no-issue label 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 - .nvmrc pins v24.13.1. Now points at .nvmrc with the concrete version and mentions nvm use.

  • pnpm appeared from nowhere. pnpm install was the first command with no explanation of where pnpm comes from. Added nvm use + corepack enable pnpm as one-off setup. Corepack reads pnpm@10.25.0 from the packageManager field, 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 dev starts 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)

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VRcoUyMuvLA51GPLK1Bdwo
Copilot AI review requested due to automatic review settings August 7, 2026 01:39
@isaaclombardssw isaaclombardssw added the no-issue This label is used to bypass the PR-Lint check. Should be used for non-coding changes label Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Coverage report

St.
Category Percentage Covered / Total
🔴 Statements 0.94% 448/47864
🔴 Branches 15.02% 85/566
🔴 Functions 2.88% 14/486
🔴 Lines 0.94% 448/47864

Test suite run success

27 tests passing in 3 suites.

Report generated by 🧪jest coverage report action from 9f94b91

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 .nvmrc and add nvm use to 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 dev results in multiple localhost ports.
Suppressed comments (1)

README.md:36

  • The sentence "Both are one-off" is misleading: corepack enable pnpm is typically one-time per machine/user, but nvm use generally needs to be run whenever the current shell isn't already using the .nvmrc version (often each new terminal session). Reword to avoid implying nvm use is 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 thread README.md
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-issue This label is used to bypass the PR-Lint check. Should be used for non-coding changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants