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

fix(docs): single quote to double #1416

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Jun 5, 2024

Changes

  • change single quotes to double for consistency sake of the code examples

Summary by CodeRabbit

  • Documentation
    • Updated the directive format in the server components guide for consistency and clarity.
    • Clarified error scenarios related to user events passed as props.

@SutuSebastian SutuSebastian added the 📚 documentation Improvements or additions to documentation label Jun 5, 2024
@SutuSebastian SutuSebastian self-assigned this Jun 5, 2024
Copy link

vercel bot commented Jun 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 5, 2024 9:32am
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 5, 2024 9:32am

Copy link

changeset-bot bot commented Jun 5, 2024

⚠️ No Changeset found

Latest commit: f015332

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jun 5, 2024

Walkthrough

The primary change involves updating the directive from 'use client' to "use client" throughout the server-components.mdx file. This ensures consistency in directive usage and clarifies error scenarios related to user events passed as props.

Changes

Files Change Summary
apps/web/content/docs/getting-started/... Updated all instances of 'use client' to "use client" and clarified error scenarios with user events.

Poem

In the world of code, where changes gleam,
We swapped the quotes, like in a dream.
Directives now with double flair,
Consistency found, errors laid bare.
Onward we code, with clarity in sight,
Our server components shining bright! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@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: 1

Outside diff range and nitpick comments (2)
apps/web/content/docs/getting-started/server-components.mdx (2)

Line range hint 48-48: Refine the sentence structure for clarity.

- Compound components DO NOT work in React Server Components, therefore each component must be specifically imported as such:
+ Compound components DO NOT work in React Server Components; therefore, each component must be specifically imported as such:

Line range hint 92-92: Ensure proper punctuation in lists.

- Here's a list of all Flowbite React components that are fully rendered on the server:  `Alert`, `Avatar`, `Badge`, `Banner`, `Blockquote`, ...
+ Here's a list of all Flowbite React components that are fully rendered on the server: `Alert`, `Avatar`, `Badge`, `Banner`, `Blockquote`, ...
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b2640bc and f015332.

Files selected for processing (1)
  • apps/web/content/docs/getting-started/server-components.mdx (5 hunks)
Additional context used
LanguageTool
apps/web/content/docs/getting-started/server-components.mdx

[typographical] ~48-~48: The word “therefore” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... components DO NOT work in React Server Components, therefore each component must be specifically imp...


[uncategorized] ~92-~92: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e fully rendered on the server: Alert, Avatar, Badge, Banner, `Blockquot...


[style] ~96-~96: In American English, abbreviations like “etc.” require a period. (ETC_PERIOD)
Context: ... props (such as onClick, onBlur, ...etc) DO NOT work in React Server Components...

Additional comments not posted (4)
apps/web/content/docs/getting-started/server-components.mdx (4)

12-12: Consistency in quoting style maintained.


22-22: Consistency in quoting style maintained.


34-34: Consistency in quoting style maintained.


88-88: Consistency in quoting style maintained.

@SutuSebastian SutuSebastian merged commit 3f921d9 into main Jun 5, 2024
8 checks passed
@SutuSebastian SutuSebastian deleted the fix(docs)/double-quotes branch June 5, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant