Skip to content

Conversation

@fmoessle
Copy link

@fmoessle fmoessle commented Dec 8, 2025

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@fmoessle fmoessle requested a review from pi0 as a code owner December 8, 2025 14:19
@vercel
Copy link

vercel bot commented Dec 8, 2025

@fmoessle is attempting to deploy a commit to the Nitro Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link

coderabbitai bot commented Dec 8, 2025

πŸ“ Walkthrough

Walkthrough

Updated Vercel deployment docs: clarified ISR route rule behavior to state query parameters influence cache keys but aren't forwarded to route handlers unless configured; fixed a typo.

Changes

Cohort / File(s) Summary
Documentation: Vercel ISR caching behavior
docs/2.deploy/20.providers/vercel.md
Reworded ISR route rules description: changed "query paramas are ignored by cache" to state that query params affect cache keys but are not passed to the route handler unless specified; corrected typo "paramas" β†’ "params".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single small documentation edit; verify phrasing and surrounding context for accuracy.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The pull request description contains only the contributor guidance template with no actual description of the changes provided by the author. Please provide a meaningful description of the changes made, explaining what was fixed and why this change improves the documentation.
βœ… Passed checks (2 passed)
Check name Status Explanation
Title check βœ… Passed The pull request title 'docs(vercel): fix ISR wording' follows the conventional commits format with a type and scope.
Docstring Coverage βœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
πŸ§ͺ Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

πŸ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 5c6cc3d and 724406e.

πŸ“’ Files selected for processing (1)
  • docs/2.deploy/20.providers/vercel.md (1 hunks)
🧰 Additional context used
πŸͺ› LanguageTool
docs/2.deploy/20.providers/vercel.md

[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...uery params affect cache keys but are not passed to the route handler unless spec...

(UNLIKELY_OPENING_PUNCTUATION)

πŸ”‡ Additional comments (1)
docs/2.deploy/20.providers/vercel.md (1)

89-89: Approvedβ€”wording clarification is accurate and resolves misleading original statement.

The revised wording correctly distinguishes between two behaviors:

  1. Query params do affect cache keys (e.g., ?a=1 and ?a=2 generate separate cache entries)
  2. Query params are not passed to the route handler unless explicitly configured via passQuery: true

This accurately reflects the ISR route rule behavior and aligns with the agreed feedback from the previous review discussion. The original statement ("query params are ignored by cache") was misleading because it incorrectly suggested query params don't influence caching at all.

Note on static analysis flag: LanguageTool flagged a "loose punctuation mark," but the sentence appears grammatically correct with proper punctuation. This is likely a false positiveβ€”you may safely disregard it unless you identify a subtle grammar issue.


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 and usage tips.

@pi0 pi0 changed the title docs: fix Vercel ISR query params wording docs(vercel): fix ISR wording Dec 8, 2025
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.

2 participants