Skip to content

docs: use emphasis instead of quotes #32078

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 13, 2025
Merged

docs: use emphasis instead of quotes #32078

merged 1 commit into from
May 13, 2025

Conversation

xjccc
Copy link
Contributor

@xjccc xjccc commented May 12, 2025 •
edited
Loading

🔗 Linked issue

📚 Description

before:

image

after:

image

Emmm.. I also find some config is not used? Like resetAsyncDataToUndefined|compileTemplate|templateUtils|relativeWatchPaths, is these should removed?

@xjccc xjccc requested a review from danielroe as a code owner May 12, 2025 07:02
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 12, 2025 •
edited
Loading

Walkthrough

The changes update documentation in the "getting started" and "going further" sections by removing the commented-out configuration line resetAsyncDataToUndefined: true from Nuxt config examples. The explanation of the removed boolean aliases for the dedupe option in the refresh method of useAsyncData is reformatted using bold and italic text instead of single quotes, without altering meaning. Migration instructions for default data and error values in useAsyncData and useFetch are revised to instruct explicit default value settings under experimental.defaults.useAsyncData. No changes affect control flow, error handling, or exported/public entities.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6dcd807 and 777af56.

📒 Files selected for processing (1)
  • docs/1.getting-started/18.upgrade.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/1.getting-started/18.upgrade.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed May 12, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/1.getting-started/18.upgrade.md (1)

664-664: Clarity: simplify the phrasing for improved readability.
The current sentence is accurate but a bit verbose. Consider streamlining and using parallel structure, for example:

`refresh({ dedupe: false })` means **do not _cancel_ existing requests in favour of this new one**, while `refresh({ dedupe: true })` means **do not initiate a new request if one is already pending**.

This keeps the emphasis consistent and reduces cognitive load.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 23f57e9 and f47af14.

📒 Files selected for processing (1)
  • docs/1.getting-started/18.upgrade.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint-docs

@xjccc xjccc force-pushed the docs/getting-started-upgrade branch from 777af56 to f47af14 Compare May 13, 2025 09:52
@danielroe danielroe changed the title docs: improve the explaination docs: use emphasis instead of quotes May 13, 2025
@danielroe danielroe enabled auto-merge May 13, 2025 11:15
@danielroe danielroe disabled auto-merge May 13, 2025 11:22
@danielroe danielroe added this pull request to the merge queue May 13, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks May 13, 2025
@danielroe danielroe added this pull request to the merge queue May 13, 2025
Merged via the queue into nuxt:main with commit d3432b4 May 13, 2025
16 of 17 checks passed
@github-actions github-actions bot mentioned this pull request May 13, 2025
Merged
@xjccc xjccc deleted the docs/getting-started-upgrade branch May 14, 2025 00:10
danielroe pushed a commit that referenced this pull request May 15, 2025
@xjccc @danielroe
docs: use emphasis instead of quotes (#32078)
74e9f8a
@github-actions github-actions bot mentioned this pull request May 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@xjccc @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy