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): incorrect default drawer placement #4810

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Feb 9, 2025

Closes #4809

📝 Description

To correct the default drawer placement.

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated the Drawer component guide to clearly indicate that the default placement is right, with left remaining as an option.

Verified

This commit was signed with the committer’s verified signature.
knqyf263 Teppei Fukuda
Copy link

linear bot commented Feb 9, 2025

Copy link

changeset-bot bot commented Feb 9, 2025

⚠️ No Changeset found

Latest commit: 2d98fed

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

vercel bot commented Feb 9, 2025

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

Name Status Preview Comments Updated (UTC)
heroui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 9, 2025 2:38am
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 9, 2025 2:38am

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Feb 9, 2025
Copy link
Contributor

coderabbitai bot commented Feb 9, 2025

Walkthrough

This pull request updates the documentation for the Drawer component. It reorders the placement options and explicitly sets the default placement to “right” rather than “left”. The modification ensures that the documentation accurately reflects that the Drawer component is configured with a right default placement while retaining “left” as an available option.

Changes

File Change Summary
apps/.../drawer.mdx Updated the documentation for the Drawer component by correcting the default placement to “right”.

Assessment against linked issues

Objective Addressed Explanation
Correct default placement in Drawer docs (#4809)

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f386f1f and 2d98fed.

📒 Files selected for processing (1)
  • apps/docs/content/docs/components/drawer.mdx (1 hunks)
🔇 Additional comments (1)
apps/docs/content/docs/components/drawer.mdx (1)

87-90: Confirm Default Drawer Placement Update

The updated documentation correctly indicates that the default placement for the Drawer component is now “right” (as shown in “- right (default)”), aligning with the API table later in the file. Please verify that all related sections and examples consistently reflect this change.


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>, 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.

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. (Beta)
  • @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.

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.

@jrgarciadev jrgarciadev merged commit 7a95c7f into main Feb 11, 2025
3 checks passed
@jrgarciadev jrgarciadev deleted the docs/eng-2041 branch February 11, 2025 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Scope : Docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - Drawer docs mistake
2 participants