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: update code to show how to enable typedPages #24436

Merged
merged 1 commit into from Nov 23, 2023

Conversation

maninak
Copy link
Contributor

@maninak maninak commented Nov 23, 2023

πŸ”— Linked issue

There is no related issue for this PR, to my knowledge.

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

At the "Experimental Features" page of the docs, in the "typedPages" section, while the description implies that the code that follows will enable the feature, it actually disables it.

Source: https://nuxt.com/docs/guide/going-further/experimental-features#typedpages

Screenshot:

image

In fact this fooled me enough to actually erroneously copy it from the docs as is! πŸ€¦β€β™‚οΈ
Thankfully my colleague caught it in the PR review.

This PR fixes the example to correctly suggest setting the value true for the property typedPages under experimental in nuxt.config.js.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

stackblitz bot commented Nov 23, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

nuxt-studio bot commented Nov 23, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio β†—οΈŽ View Live Preview 09cdb80

@maninak maninak changed the title docs(experimental): don't misleadingly suggest typedPages: false docs(nuxt): don't misleadingly suggest typedPages: false Nov 23, 2023
@danielroe
Copy link
Member

Thanks! Nice catch.

@danielroe danielroe changed the title docs(nuxt): don't misleadingly suggest typedPages: false docs: update code to show how to enable typedPages Nov 23, 2023
@danielroe danielroe merged commit 36aee52 into nuxt:main Nov 23, 2023
10 checks passed
@github-actions github-actions bot mentioned this pull request Nov 23, 2023
@maninak maninak deleted the docs/typedpages-suggest-true branch November 23, 2023 20:57
@github-actions github-actions bot mentioned this pull request Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants