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.

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

refactor(docs): sort component routes alphabetically #3328

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from
Open

refactor(docs): sort component routes alphabetically #3328

wants to merge 1 commit into from

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Jun 26, 2024 •
edited by coderabbitai bot
Loading

Closes #3323

📝 Description

As titled.

P.S Point to canary since this is not urgent and avoid conflicts if we have further routes changes.

⛳️ 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 documentation routes to include new entries for "Avatar," "Breadcrumbs," "Calendar," "Circular Progress," "Input," "Range Calendar," "Scroll Shadow," "Slider," and "Time Input."
  • Bug Fixes
    • Resolved issues with missing or outdated entries for "Avatar" and "Input".

@linear Linear
Copy link

linear bot commented Jun 26, 2024

ENG-1053 [BUG] - Documentation for components is not in alphabetical order

@vercel Vercel
Copy link

vercel bot commented Jun 26, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2024 6:18am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2024 6:18am

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jun 26, 2024

⚠️ No Changeset found

Latest commit: 3f9c2e5

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

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 26, 2024 •
edited
Loading

Walkthrough

The updates in routes.json enhance the documentation by adding, removing, and modifying various component entries. These changes aim to organize the components alphabetically, improving the user experience by making it easier to find and navigate through the components.

Changes

File Path Change Summary
apps/docs/config/routes.json Entries updated for components: addition of several new components, removal and re-entry of "Avatar" and "Input," all sorted alphabetically.

Assessment against linked issues

Objective Addressed Explanation
Ensure documentation components are listed in alphabetical order (#3323) ✅

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.

@wingkwong wingkwong added this to the v2.4.3 milestone Jun 26, 2024
coderabbitai[bot]
coderabbitai bot reviewed Jun 26, 2024
View reviewed changes
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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 720f2f5 and 3f9c2e5.

Files selected for processing (1)
  • apps/docs/config/routes.json (8 hunks)
Additional comments not posted (6)
apps/docs/config/routes.json (6)

148-152: LGTM: Properly added "Avatar" component back with complete details.

161-165: LGTM: "Breadcrumbs" component added correctly according to specifications.

173-177: LGTM: "Calendar" component addition with 'newPost' flag is appropriate.

205-209: LGTM: "Circular Progress" component added correctly.

256-260: LGTM: "Input" component re-added with complete and correct details.

316-321: LGTM: New components ("Range Calendar", "Scroll Shadow", "Slider", and "Time Input") added correctly.

Also applies to: 323-327, 342-346, 391-396

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@jrgarciadev jrgarciadev Awaiting requested review from jrgarciadev jrgarciadev is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@jrgarciadev jrgarciadev

Labels
None yet
Projects
None yet
Milestone
v2.4.3
Development

Successfully merging this pull request may close these issues.

[BUG] - Documentation for components is not in alphabetical order
2 participants
@wingkwong @jrgarciadev