Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add some helpful notes for Incremental Static Regeneration #12030

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

leoj3n
Copy link
Contributor

@leoj3n leoj3n commented Mar 24, 2024

Hopefully this is helpful, explaining some of the steps one would have to go through for Vercel ISR in more detail.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Mar 24, 2024

⚠️ No Changeset found

Latest commit: 4f1425e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@leoj3n
Copy link
Contributor Author

leoj3n commented Mar 24, 2024

A number of additional things are touched on in the comments of the referenced issues (seen above).

At any rate, I think these ISR docs could be more helpful overall, to better explain the functionality and limitations/edge cases users are likely to encounter.

As long as there is no dedication function for doing so, I think it would also be good to show a generic example of revalidating a given route (which most seem to do via fetch with the special header set). Something like:

@benmccann benmccann added documentation Improvements or additions to documentation pkg:adapter-vercel Pertaining to the Vercel adapter labels Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pkg:adapter-vercel Pertaining to the Vercel adapter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants