Skip to content

docs: align Node.js setup versions with engine - #588

Open
dajiaohuang wants to merge 1 commit into
elie222:mainfrom
dajiaohuang:docs/node-engine-range
Open

docs: align Node.js setup versions with engine#588
dajiaohuang wants to merge 1 commit into
elie222:mainfrom
dajiaohuang:docs/node-engine-range

Conversation

@dajiaohuang

@dajiaohuang dajiaohuang commented Sep 4, 2026

Copy link
Copy Markdown

Problem

The setup documentation advertised Node.js versions outside the repository's declared engine range. SETUP_PROMPT.md allowed Node 22.12+, while package.json requires ^22.22.2 || ^24.0.0 || >=26.0.0; README.md said only “Node.js 22+”.

Change

Align the README and setup prompt with the exact package.json contract. 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 --check
  • pnpm lint (not runnable in the fresh clone because dependencies are not installed; the change is Markdown-only)

Summary by CodeRabbit

  • Documentation
    • Updated local development prerequisites to specify supported Node.js versions: ^22.22.2, ^24.0.0, or >=26.0.0.
    • Aligned setup guidance with the supported Node.js versions while retaining the existing pnpm requirements and version-check instructions.

@vercel

vercel Bot commented Sep 4, 2026

Copy link
Copy Markdown

@dajiaohuang is attempting to deploy a commit to the Inbox Zero Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: 70f1e6bc-a8d5-435c-9e5f-18133c31b835

📥 Commits

Reviewing files that changed from the base of the PR and between 2b399a9 and d6f9f29.

📒 Files selected for processing (2)
  • README.md
  • SETUP_PROMPT.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The 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.

Changes

Node.js engine documentation

Layer / File(s) Summary
Align documented Node.js versions
README.md, SETUP_PROMPT.md
Both documents now require Node.js ^22.22.2, ^24.0.0, or >=26.0.0. The existing pnpm and version-check instructions remain unchanged.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to d6f9f

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: elie222, fetw882, cursoragent

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and its purpose: aligning Node.js setup versions with the package engine.
Linked Issues check ✅ Passed The pull request updates both README.md and SETUP_PROMPT.md to require the exact Node.js engine range: ^22.22.2, ^24.0.0, or >=26.0.0. This removes implied support for unsupported Node.js 22.x, 23.x, …
Out of Scope Changes check ✅ Passed The changes are limited to documentation updates required by issue #587. No unrelated code or configuration changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR aligns developer setup documentation with the existing Node.js engine contract.

  • Replaces the broad README requirement of Node.js 22+ with the exact supported ranges.
  • Updates the setup prompt to use the same ranges declared in package.json.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

Both changed files reproduce the existing Node.js engine ranges accurately, and no conflicting repository setup requirement or actionable regression was identified.

Important Files Changed

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

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

Playwright screenshots

No new feature frames; gallery is suite-vs-main drift.

Open screenshot gallery · Dashboard · CI run

Updated for commit d6f9f29.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: align Node.js setup versions with package engine

1 participant