docs: Add some helpful notes for Incremental Static Regeneration

[leoj3n]

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
• [x] 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

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

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 0550a7860d309d01ba18999c74222e2618defaf1

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]

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:

• https://github.com/jdgamble555/isr-test/blob/master/src/routes/revalidate/%2Bpage.server.ts
• https://github.com/binsarjr/apiliburnasional/blob/7a10a92a339d9ccaaba71f5f6e1be28aa879fcaf/src/routes/api/revalidate/%2Bserver.ts

[dummdidumm]

The changes around prerendering are not accurate. I think it's better to move the things that are parts of the comments in the code snippet out into better visible text and enhance those a bit. While digging into this I also noticed some flaws in the current implementation, will get back to this.

[Rich-Harris]

preview: https://svelte-dev-git-preview-kit-12030-svelte.vercel.app/

this is an automated message