fix: correct links in docs

[ryo-manba]

Closes #

📝 Description

I have corrected the broken link and also fixed a typo.

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

• New Features

  • Updated the ComponentLinks to optionally include links to NPM and source code, enhancing navigation and resource accessibility.
  • Enhanced customization of class names for the Input component, allowing more styling flexibility.

• Documentation

  • Added new attributes to the ComponentLinks in documentation for the radio-group and scroll-shadow components, improving reference materials and examples.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f422fc3

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

[vercel]

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	Apr 14, 2024 7:02am

[vercel]

@ryo-manba is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing component documentation and customization. The ComponentLinks component now supports optional npm and source links, improving resource accessibility. Additionally, the input component documentation has been revised for better clarity in customizing class names, and specific references have been added in the scroll-shadow documentation for improved navigation.

Changes

File Path	Change Summary
.../docs/components/component-links.tsx	Added optional npm and source properties to ComponentLinks props.
.../docs/components/input.mdx	Updated classNames property to customize class names for Input slots.
.../docs/components/radio-group.mdx	Added npm, styles, source attributes to <ComponentLinks>.
.../docs/components/scroll-shadow.mdx	Updated <ComponentLinks> to include a specific storybook reference.

---

Recent Review Details

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 2829d4a and f422fc3.

Files selected for processing (4)

• apps/docs/components/docs/components/component-links.tsx (4 hunks)
• apps/docs/content/docs/components/input.mdx (1 hunks)
• apps/docs/content/docs/components/radio-group.mdx (1 hunks)
• apps/docs/content/docs/components/scroll-shadow.mdx (1 hunks)

Additional comments not posted (7)

apps/docs/content/docs/components/scroll-shadow.mdx (1)

12-12: Updated ComponentLinks to include a storybook link. Ensure that the scrollshadow storybook entry exists and is correctly named to match this reference.

apps/docs/components/docs/components/component-links.tsx (4)

11-12: Added optional npm and source properties to ComponentLinksProps. Ensure these properties are documented and their usage is clear to other developers.

---

65-66: The npm and source properties are now used in the ComponentLinks rendering logic. This is a good use of optional chaining to provide fallbacks. Ensure that the fallbacks (component name) are appropriate in all use cases.

---

87-90: The NPM link now dynamically uses the npm property if available. This change enhances the flexibility of the component. Ensure that all NPM package names follow the format @nextui-org/{name}.

---

120-123: The source link now dynamically uses the source property if available. This change allows for more accurate linking to the source code. Verify that the COMPONENT_PATH constant correctly points to the GitHub repository path.

Verification successful

---

The COMPONENT_PATH constant is defined to point to different paths based on the __PREVIEW__ condition. If __PREVIEW__ is true, it points to the feat/v2 branch under packages/components. Otherwise, it points to the main branch under packages/components. Both paths are correctly constructed to link to the GitHub repository nextui-org/nextui.

This setup allows the source link in the ButtonLink component to dynamically use the source property if available, and correctly formulates the URL to the GitHub repository, ensuring accurate linking to the source code of the components.

Based on this information, the review comment is verified as the COMPONENT_PATH correctly points to the GitHub repository path, and the dynamic use of the source property is appropriately implemented.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that COMPONENT_PATH points to the correct GitHub repository path
cat apps/docs/components/docs/components/component-links.tsx | grep "COMPONENT_PATH"

Length of output: 220

---

---

Script:

#!/bin/bash
# Check the contents of "@/libs/github/constants" to verify the value of `COMPONENT_PATH`
fd "constants" apps/docs/libs/github --exec cat {}

Length of output: 831

apps/docs/content/docs/components/radio-group.mdx (1)

12-12: Updated ComponentLinks to include npm, styles, and source attributes. This enhancement provides more detailed and useful links for the component. Ensure that the specified links are valid and lead to the correct resources.

apps/docs/content/docs/components/input.mdx (1)

208-208: Ensure the classNames property correctly reflects the intended slots for customization.

The update to the classNames property is intended to allow users to set custom class names specifically for the Input component's slots. This change enhances the flexibility and customization capabilities of the component, making it more adaptable to different styling needs.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

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

[jrgarciadev]

Thanks! @ryo-manba