docs: align Node.js setup versions with engine - #588
Conversation
|
@dajiaohuang is attempting to deploy a commit to the Inbox Zero Team on Vercel. A member of the Team first needs to authorize it. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe README and setup prompt now document Node.js versions that match the declared package engine ranges. The pnpm requirement and version verification guidance remain unchanged. ChangesNode.js engine documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The setup documentation now accurately states the supported Node.js versions, preventing users from selecting unsupported releases. The documentation-only change is ready to merge. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThe PR aligns developer setup documentation with the existing Node.js engine contract.
|
| Filename | Overview |
|---|---|
| README.md | Accurately replaces the broad Node.js prerequisite with the repository’s declared engine ranges. |
| SETUP_PROMPT.md | Accurately updates setup guidance to select a Node.js version allowed by package.json. |
Reviews (1): Last reviewed commit: "docs: align Node.js setup versions with ..." | Re-trigger Greptile
Playwright screenshotsNo new feature frames; gallery is suite-vs-main drift. Open screenshot gallery · Dashboard · CI run Updated for commit |
Problem
The setup documentation advertised Node.js versions outside the repository's declared engine range.
SETUP_PROMPT.mdallowed Node 22.12+, whilepackage.jsonrequires^22.22.2 || ^24.0.0 || >=26.0.0;README.mdsaid only “Node.js 22+”.Change
Align the README and setup prompt with the exact
package.jsoncontract. This avoids implying unsupported Node 23.x or 25.x versions and keeps the documentation consistent with the existing package configuration.Fixes #587
Validation
git diff --checkpnpm lint(not runnable in the fresh clone because dependencies are not installed; the change is Markdown-only)Summary by CodeRabbit
^22.22.2,^24.0.0, or>=26.0.0.