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): listbox with description #2513

Merged

Conversation

kuri-sun
Copy link
Member

@kuri-sun kuri-sun commented Mar 13, 2024

Closes #

📝 Description

The code is not visible for the Listbox with Description example.

⛳️ Current behavior (updates)

The JS codes are not visible.

🚀 New behavior

Screen.Recording.2024-03-13.at.5.17.06.PM.mov

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

no

📝 Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated the listbox documentation to reflect changes in code demonstration settings.

Copy link

changeset-bot bot commented Mar 13, 2024

⚠️ No Changeset found

Latest commit: 3e49b49

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 Mar 13, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 13, 2024 8:20am

Copy link

vercel bot commented Mar 13, 2024

@kuri-sun is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Mar 13, 2024

Walkthrough

This update involves a simplification in the documentation component usage by removing a specific TypeScript-related property from the CodeDemo component within the listbox.mdx documentation file. The change aims to streamline the presentation or possibly align with updated component requirements or TypeScript settings.

Changes

File Change Summary
.../docs/components/listbox.mdx Removed typescriptStrict={true} prop from CodeDemo

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 5a8768a and 3e49b49.
Files selected for processing (1)
  • apps/docs/content/docs/components/listbox.mdx (1 hunks)
Check Runs (5)
TypeScript completed (1)
Build completed (1)
Prettier completed (1)
ESLint completed (1)
Tests completed (1)
Additional comments: 1
apps/docs/content/docs/components/listbox.mdx (1)
  • 101-106: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-322]

The removal of typescriptStrict={true} from the CodeDemo component is aimed at fixing the issue where JavaScript code examples were not being displayed to the reader. This change appears to directly address the problem without introducing any visible side effects or breaking changes. However, it's important to ensure that this adjustment does not inadvertently affect the display or functionality of TypeScript examples, if any are present or planned for the future in the documentation.

Given the nature of the change, it's also crucial to verify that all instances of CodeDemo throughout the documentation are consistent with this new approach, ensuring a uniform experience for users. Additionally, consider adding a brief comment or documentation internally to explain the rationale behind this change for future maintainers.

Overall, the change seems well-targeted and effective for the stated objective of making JavaScript code examples visible in the Listbox component documentation. Just ensure to keep an eye on the broader implications for TypeScript examples and maintain consistency across the documentation.

@wingkwong wingkwong mentioned this pull request Mar 14, 2024
@kuri-sun kuri-sun marked this pull request as draft March 14, 2024 15:32
@kuri-sun kuri-sun marked this pull request as ready for review March 14, 2024 17:24
@kuri-sun kuri-sun marked this pull request as draft March 15, 2024 03:15
@kuri-sun kuri-sun marked this pull request as ready for review March 16, 2024 00:19
@jrgarciadev jrgarciadev merged commit 9496ab5 into nextui-org:main Mar 16, 2024
7 of 8 checks passed
@kuri-sun kuri-sun deleted the listbox-with-description-eng-497 branch March 16, 2024 14:15
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