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): broken links #3796

Merged
merged 2 commits into from
Sep 23, 2024
Merged

fix(docs): broken links #3796

merged 2 commits into from
Sep 23, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Sep 23, 2024

Closes #3795

📝 Description

as title

⛳️ 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

  • Documentation
    • Corrected the formatting of the URL for the ValidationResult reference in the Date Picker component documentation for improved clarity.
    • Updated hyperlink formatting in the Date Input, Date Range Picker, and Time Input documentation to ensure proper rendering.

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Sep 23, 2024
Copy link

changeset-bot bot commented Sep 23, 2024

⚠️ No Changeset found

Latest commit: 4379b0d

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 Sep 23, 2024

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 Sep 23, 2024 3:46pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 23, 2024 3:46pm

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

The pull request implements minor formatting corrections across several documentation files for the Date Picker, Date Input, Date Range Picker, and Time Input components. Specifically, it addresses a dead link issue by correcting the URL for the ValidationResult reference, ensuring proper navigation to the relevant GitHub file. These changes enhance the clarity of the documentation without affecting any functionality or logic in the code.

Changes

File Change Summary
apps/docs/content/docs/components/date-picker.mdx Corrected formatting of the ValidationResult URL by removing extra parentheses.
apps/docs/content/docs/components/date-input.mdx Corrected formatting of the ValidationResult URL by removing extra parentheses.
apps/docs/content/docs/components/date-range-picker.mdx Corrected formatting of the ValidationResult URL by removing extra parentheses.
apps/docs/content/docs/components/time-input.mdx Corrected formatting of the ValidationResult URL by removing extra parentheses.

Assessment against linked issues

Objective Addressed Explanation
Redirection to the GitHub file for ValidationResult (#3795)

Possibly related PRs

Suggested reviewers

  • jrgarciadev
  • winchesHe

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1a00766 and 4379b0d.

Files selected for processing (3)
  • apps/docs/content/docs/components/date-input.mdx (1 hunks)
  • apps/docs/content/docs/components/date-range-picker.mdx (1 hunks)
  • apps/docs/content/docs/components/time-input.mdx (1 hunks)
Files skipped from review due to trivial changes (3)
  • apps/docs/content/docs/components/date-input.mdx
  • apps/docs/content/docs/components/date-range-picker.mdx
  • apps/docs/content/docs/components/time-input.mdx

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

@wingkwong wingkwong changed the title fix(docs): broken link in date-picker page fix(docs): broken links Sep 23, 2024
@wingkwong wingkwong marked this pull request as ready for review September 23, 2024 15:44
@wingkwong wingkwong changed the base branch from canary to main September 23, 2024 16:13
@jrgarciadev jrgarciadev merged commit e10ea00 into main Sep 23, 2024
8 checks passed
@jrgarciadev jrgarciadev deleted the fix/broken-link-in-docs branch September 23, 2024 16:21
@coderabbitai coderabbitai bot mentioned this pull request Nov 2, 2024
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] [DOCS] - Dead Link in Datepicker Docs
2 participants