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: Update Nextjs Pages Template URLs #4762

Closed
wants to merge 2 commits into from

Conversation

the-r3aper7
Copy link

@the-r3aper7 the-r3aper7 commented Jan 29, 2025

Closes #

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated Next.js project creation command URLs from heroui-org to heroui-inc
    • Corrected GitHub repository link for HeroUI CLI documentation
    • Changed package name in accordion documentation from @heroui-org/accordion to @heroui-inc/accordion

Copy link

vercel bot commented Jan 29, 2025

@the-r3aper7 is attempting to deploy a commit to the HeroUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

changeset-bot bot commented Jan 29, 2025

⚠️ No Changeset found

Latest commit: deae7ea

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
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request introduces updates to various documentation files, primarily focusing on changing URLs to reflect a transition from the heroui-org organization to heroui-inc. Specifically, the URLs for the create-next-app commands in the Next.js documentation and the GitHub repository link in the CLI guide have been updated. Additionally, the package name in the accordion component's README has been modified to align with the new organization name.

Changes

File Change Summary
apps/docs/content/docs/frameworks/nextjs.mdx Updated GitHub repository URLs from heroui-org to heroui-inc for npm, yarn, and pnpm create next-app commands
apps/docs/content/docs/guide/cli.mdx Updated GitHub repository link from heroui-org to heroui-inc
packages/components/accordion/README.md Changed package name from @heroui-org/accordion to @heroui-inc/accordion

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b2b8f56 and deae7ea.

📒 Files selected for processing (2)
  • apps/docs/content/docs/guide/cli.mdx (1 hunks)
  • packages/components/accordion/README.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • apps/docs/content/docs/guide/cli.mdx
  • packages/components/accordion/README.md

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. (Beta)
  • @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.

@the-r3aper7 the-r3aper7 changed the title Update Nextjs Pages Template URLs docs: Update Nextjs Pages Template URLs Jan 29, 2025
Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please also change in heroui/apps/docs/content/docs/guide/cli.mdx and packages/components/accordion/README.md

@the-r3aper7
Copy link
Author

yeah sure

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Jan 30, 2025
@wingkwong
Copy link
Member

Closing this one - #4645 covers the changes.

@wingkwong wingkwong closed this Jan 30, 2025
@the-r3aper7 the-r3aper7 deleted the patch-1 branch January 30, 2025 13:40
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.

3 participants