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

docs(form): form guide link typo #4339

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Conversation

Peterl561
Copy link
Contributor

@Peterl561 Peterl561 commented Dec 11, 2024

Closes #

📝 Description

  • link to forms guide in form docs has a typo

⛳️ Current behavior (updates)

click the forms guide link and it will 404
https://nextui.org/docs/components/form#validation

Capture

🚀 New behavior

link should work

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

No

📝 Additional Information

Summary by CodeRabbit

  • Documentation
    • Enhanced the usage section with a code demo for the Form component.
    • Updated the validation section to include examples of server-side validation.
    • Corrected the reference path in the forms guide.
    • Clarified the accessibility compliance details for the Form component.
    • Provided detailed descriptions of props in the API section.
    • Maintained the installation and import sections without changes.

Copy link

changeset-bot bot commented Dec 11, 2024

⚠️ No Changeset found

Latest commit: 1892043

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 Dec 11, 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 Dec 12, 2024 2:18am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 2:18am

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The pull request updates the documentation for the Form component, maintaining the title and description while revising sections related to usage, validation, and accessibility. The installation commands and import statements remain unchanged. The documentation now includes code demonstrations for functionalities such as server-side validation and event handling. A minor textual correction was made in the reference path for the forms guide. No changes were made to the declarations of exported or public entities.

Changes

File Path Change Summary
apps/docs/content/docs/components/form.mdx Updated usage, validation, and accessibility sections with code demos; corrected forms guide path.

Possibly related PRs

  • docs: add forms guide #3822: The addition of a forms guide directly relates to the documentation updates for the Form component, as both aim to enhance understanding and usage of forms within the NextUI project.

Suggested labels

📋 Scope : Docs

Suggested reviewers

  • wingkwong
  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ca6c951 and 1892043.

📒 Files selected for processing (1)
  • apps/docs/content/docs/components/form.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/docs/components/form.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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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
Copy link
Member

the Hey @Peterl561 switch the base branch to "main" as this change is a typo fix

@Peterl561 Peterl561 changed the base branch from canary to main December 12, 2024 02:07
@Peterl561 Peterl561 marked this pull request as draft December 12, 2024 02:09
@OwLu0905
Copy link
Contributor

Hi, I noticed some other broken links, including internal guides/* path issues and some external documentation links returning 404 errors. Would you mind if I create another PR to fix these, or would you prefer I address them in this PR?

@Peterl561
Copy link
Contributor Author

Peterl561 commented Dec 12, 2024

Hi, I noticed some other broken links, including internal guides/* path issues and some external documentation links returning 404 errors. Would you mind if I create another PR to fix these, or would you prefer I address them in this PR?

Since you know where the issues are already feel free to open a new PR to fix them :) @OwLu0905

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Dec 12, 2024
@jrgarciadev jrgarciadev merged commit 8e1ace5 into main Dec 12, 2024
3 checks passed
@jrgarciadev jrgarciadev deleted the docs/form-guide-link-typo branch December 12, 2024 12:13
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.

4 participants