Skip to content

docs: add Building guide#92507

Draft
aurorascharff wants to merge 43 commits intocanaryfrom
docs/getting-started-building
Draft

docs: add Building guide#92507
aurorascharff wants to merge 43 commits intocanaryfrom
docs/getting-started-building

Conversation

@aurorascharff
Copy link
Copy Markdown
Member

@aurorascharff aurorascharff commented Apr 8, 2026

Summary

Adds a new Building guide (docs/01-app/02-guides/building.mdx) that covers what happens when you run next build and how to work with the output.

Sections

  1. What next build does — high-level overview of the build phases (setup, route discovery, compilation, static analysis, prerendering, output)
  2. Read the build output — route table symbols ( Static, Partial Prerender) and what they mean with Cache Components
  3. Pre-render dynamic routesgenerateStaticParams, how listed/unlisted params behave, and partialFallbacks for high-cardinality sites
  4. Fix prerender errors — blocking-route error, <Suspense>/loading.js fix, --debug-prerender for stack traces, --debug-build-paths for building specific routes

Related: #92382

Closes: https://linear.app/vercel/issue/DOC-4946/getting-started-building

New guide covering next build output, generateStaticParams, and
prerender error debugging (--debug-prerender). Consolidates context
scattered across API references and error pages into a single
progressive walkthrough.

Ref: DOC-4946
Made-with: Cursor
@nextjs-bot nextjs-bot added created-by: Next.js DevEx team PRs by the DX team. Documentation Related to Next.js' official documentation. labels Apr 8, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Hi there 👋

It looks like this PR introduces broken links to the docs, please take a moment to fix them before merging:

Broken link Type File
/docs/app/api-reference/config/next-config-js/partialFallbacks link /docs/01-app/02-guides/building.mdx

Thank you 🙏

Remove ƒ (Dynamic) from symbols table since Cache Components always
produces ○ or ◐. Use actual error message text and explain the
blocking behavior using language from the blocking-route error page.

Made-with: Cursor
Extend Step 2 with guidance on experimental.partialFallbacks for sites
that can't pre-render every slug. Covers instant fallback shells for
unknown slugs and automatic upgrade after first visit.

Made-with: Cursor
Better fit as a focused guide rather than a getting-started page.
Restores deploying/upgrading to their original numbering (17/18).

Made-with: Cursor
@aurorascharff aurorascharff changed the title docs: add Getting Started > Building guide docs: add Building guide Apr 8, 2026
Flip the flow: start with the base case that fails, fix with
generateStaticParams (Step 1), then fix with Suspense (Step 2).
Build output symbols are introduced naturally when the build succeeds.

Made-with: Cursor
Explains why the build fails before showing the error, so readers
have context. Removes duplicate explanation from Step 1.

Made-with: Cursor
Link from the caching getting-started page (build output mention)
and the CLI reference (next build section).

Made-with: Cursor

For sites with many possible slugs (e-commerce with millions of products, user-generated content), pre-rendering every page at build time is not practical.

The experimental [`partialFallbacks`](/docs/app/api-reference/config/next-config-js/partialFallbacks) flag serves an instant `<Suspense>` shell from CDN for unknown slugs while the dynamic data streams in. After the first visit, the page is cached and upgraded to a fully static version.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO cc @icyJoseph create this docpage

@aurorascharff aurorascharff marked this pull request as ready for review April 8, 2026 16:17
Copilot AI review requested due to automatic review settings April 8, 2026 16:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new App Router guide documenting what happens during next build, how to interpret route output symbols (especially with Cache Components / PPR), and how to debug common prerender failures. It also adds cross-links from existing CLI and getting-started docs to direct readers to the new guide.

Changes:

  • Add a new “Building your application” guide covering build phases, output interpretation, and prerender error debugging.
  • Link to the new guide from the next build CLI reference and from getting-started “Installation” and “Deploying” pages.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
docs/01-app/03-api-reference/06-cli/next.mdx Links next build readers to the new Building guide for deeper output/debugging details.
docs/01-app/02-guides/building.mdx New guide explaining next build phases, output symbols, generateStaticParams, Suspense/PPR, and debugging flags.
docs/01-app/01-getting-started/17-deploying.mdx Adds a contextual link from build/start instructions to the Building guide.
docs/01-app/01-getting-started/01-installation.mdx Adds a “ready for production” note linking to the Building guide and Deploying docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
@aurorascharff aurorascharff marked this pull request as draft April 8, 2026 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

created-by: Next.js DevEx team PRs by the DX team. Documentation Related to Next.js' official documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants