Repository navigation
docs: trim the README's install methods - #292
Conversation
Remove explanatory lines from the npm, Nix and Docker sections, and mention generating and validating configuration in the introduction. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
![upsun-dispatch[bot]](https://avatars.githubusercontent.com/in/4153575?s=60&v=4){kind=small}
There was a problem hiding this comment.
Note
Reviewed — No blocking findings · 🔵 1 minor point
🔍 Full review · 1 file reviewed
🔵 Minor point
README.md:43— The npm section no longer says that the package needs Node.js 18 or later, or that there is no npm build for 32-bit Linux or Windows on ARM. Both limits are still real.npm/wrapper/package.json.tmpldeclares"engines": {"node": ">=18"}, andnpm/scripts/build.shpublishes only linux-x64, linux-arm64, darwin and win32-x64 (PLATFORMS=(linux-x64 linux-arm64 darwin win32-x64)). No other user-facing doc mentions them:docs/install.mdhas nothing on npm. On Windows ARM, 32-bit Linux or an old Node,npm install -g upsungives at most an engines warning or a missing optional dependency, and the wrapper then fails at run time. The README no longer explains why.
Verification
- No file in the repo links to the old
#nix-profileanchor, so renaming the heading to### Nixbreaks no link. - The new intro claim "generate and validate project configuration" is true: the native
initandlint/validatecommands do this. - The npm, Nix and Docker install commands themselves are unchanged.
This change only touches docs. No test or CI job checks the README's content.
Review details
- Commit: f806160
- Model: claude-opus-5-5
Review 1 of 10 for this pull request · View the full run
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
📋 PR Summary Shortens the README's install sections for npm, Nix and Docker by removing explanatory lines, and adds a line to the introduction about generating and validating configuration. The latest push puts a link back into the npm section that points to a new npm section in docs/install.md, which covers the package's requirements. Changes
|
There was a problem hiding this comment.
Note
Reviewed — No new issues found · 1 still open
🔁 Incremental · 1 file reviewed
Outstanding from earlier reviews:
- 🔵
README.md:43: Users on unsupported platforms or old Node versions lose the only documented explanation of the npm package's limits. — docs/install.md now lists the Node 18 and platform limits, but the README's npm section still doesn't mention them or link to docs/install.md, so README readers won't find them. (first raised)
Verification
- The new docs/install.md npm note matches
npm/wrapper/package.json.tmpl, which declares engines node >=18. - The platform list in the note matches
PLATFORMS=(linux-x64 linux-arm64 darwin win32-x64)in npm/scripts/build.sh, and darwin is a universal binary covering x64 and arm64.
This change is documentation only, so no test or CI job covers whether the docs are accurate. I checked the new text by hand against npm/scripts/build.sh and npm/wrapper/package.json.tmpl.
Review 2 of 10 for this pull request · View the full run
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
🤖 Generated with Claude Code