offline navigations: add docs and examples (10/10)#93738
Draft
feedthejim wants to merge 1 commit intofeedthejim/offline-navigations-dynamic-route-patternsfrom
Draft
offline navigations: add docs and examples (10/10)#93738feedthejim wants to merge 1 commit intofeedthejim/offline-navigations-dynamic-route-patternsfrom
feedthejim wants to merge 1 commit intofeedthejim/offline-navigations-dynamic-route-patternsfrom
Conversation
This was referenced May 10, 2026
Contributor
Tests PassedCommit: 3867a97 |
b42991d to
d05d9e9
Compare
65e9655 to
8590387
Compare
d05d9e9 to
816bee1
Compare
8590387 to
84f5627
Compare
816bee1 to
1185a06
Compare
84f5627 to
f0d70ed
Compare
1185a06 to
eff5574
Compare
f0d70ed to
be4811d
Compare
eff5574 to
3867a97
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stack Position
This is PR 10 of 10. It adds the user-facing docs and examples for
experimental.offlineNavigations.Review guide:
https://gist.github.com/feedthejim/a10f757cf07c5550f731adf2fcf1077b
Full Stack
offline navigations: add gated build primitives (1/10)offline navigations: generate fallback document artifacts (2/10)offline navigations: register pass-through worker (3/10)offline navigations: cache fallback and current-build assets (4/10)offline navigations: serve fallback document offline (5/10)offline navigations: add router-cache persistence primitives (6/10)offline navigations: persist cached router records (7/10)offline navigations: bootstrap fallback from router records (8/10)offline navigations: support dynamic route patterns (9/10)offline navigations: add docs and examples (10/10)What This Changes
This adds documentation for the first usable offline navigation scope:
experimental.offlineNavigationsconfig option;cacheComponentsrequirement;useOffline;What Works After This PR
Reviewers and early users have a guide, API reference, and cross-links that describe the same behavior implemented by PRs 1-9.
What Does Not Work Yet
This does not document a stable API. The feature remains experimental and Cache Components only. Dev simulation, custom offline miss UI, output export integration, and broader lifecycle controls remain follow-up work.
Reviewer Focus
Please focus on whether the docs explain the user-facing contract without over-documenting implementation details, and whether the caveats are practical for production apps rather than demo-only.
Proof in This PR
Docs lint passed for the edited docs:
npx eslint --config eslint.config.mjs docs/01-app/02-guides/offline-navigations.mdx docs/01-app/03-api-reference/05-config/01-next-config-js/offlineNavigations.mdxThe full stack behavior referenced by the docs is covered by:
HEADLESS=true pnpm test-start-turbo test/e2e/app-dir/offline-navigations-deploy/offline-navigations-deploy.test.tsHEADLESS=true pnpm test-start-turbo test/production/app-dir/offline-navigations/offline-navigations.test.tsHEADLESS=true pnpm test-start-webpack test/production/app-dir/offline-navigations/offline-navigations.test.tsDeferred Coverage
True deploy-mode proof is pending CI or a custom deploy run because the local
test-deploy-turboattempt timed out duringvercel link.Docs Status
This PR is the docs slice for the stack.