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: clarify draftMode interaction with force-static and dynamicParams #76907

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

Conversation

Antraxmin
Copy link

@Antraxmin Antraxmin commented Mar 7, 2025

This PR updates the documentation to clarify how draftMode interacts with force-static and dynamicParams.

Changes Included:

  • Added documentation on how draftMode interacts with force-static and dynamicParams
  • Clarified that draftMode bypasses force-static by setting the __prerender_bypass cookie
  • Explained that dynamicParams: false behavior remains unchanged
  • Documented the issue where cookies are unavailable in force-static mode
  • Provided a workaround to use headers or query parameters instead of cookies

These updates aim to improve clarity for developers using draftMode with static and dynamic configurations.

Related Issue

Request for Review:

@samcx
If there are any inconsistencies in the markdown structure or documentation style, please let me know so I can make the necessary adjustments. Thanks!

@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Mar 7, 2025
@ijjk
Copy link
Member

ijjk commented Mar 7, 2025

Allow CI Workflow Run

  • approve CI run for commit: ebd7af0

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@samcx samcx self-requested a review March 7, 2025 18:35
@samcx
Copy link
Member

samcx commented Mar 7, 2025

@Antraxmin Thank you for creating this! Taking a look—

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Related to Next.js' official documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: document how draftMode interacts with route segment configs like force-static
3 participants