Feat/getting started page

[TheOrcDev]

Summary by CodeRabbit

• New Features

  • Introduced a Getting Started page in Docs with quick-start steps, copy-to-clipboard command, and support links.
  • Updated the homepage “Get Started” button to navigate to the new Getting Started page.
  • Added “Getting Started” to the header navigation for easier access.

• Documentation

  • Added a user-friendly Getting Started guide outlining setup for 8bitcn/ui, including registry configuration and component installation instructions.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Introduces a new Getting Started docs page with static content and metadata, updates the homepage “Get Started” button to point to it, and adds a corresponding header navigation item in the shared nav configuration.

Changes

Cohort / File(s)	Summary
New docs page app/docs/getting-started/page.tsx	Adds a Next.js page exporting metadata and GettingStartedPage, rendering static Getting Started content with cards, a copy command, and external links.
Homepage link update app/page.tsx	Changes the “Get Started” Link href from /docs/components/accordion to /docs/getting-started.
Navigation config config/nav-items.ts	Appends a header nav item: label “Getting Started”, href /docs/getting-started; no signature changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User
  participant H as Home Page
  participant N as Header Nav
  participant R as Next.js Router
  participant G as GettingStartedPage

  U->>H: Load /
  alt Click homepage "Get Started"
    H->>R: Navigate to /docs/getting-started
  else Click header "Getting Started"
    N->>R: Navigate to /docs/getting-started
  end
  R->>G: Render page + metadata
  G-->>U: Static content (cards, copy command, links)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat(landing-page) update landing page Get Started button to link to … #179: Also modifies the homepage “Get Started” link target in app/page.tsx.
• Feat navigation menu #203: Updates config/nav-items.ts with new header entries, overlapping the same exported object.
• feat(themes) add metadata #206: Adds metadata to a Next.js page component, similar to the new Getting Started page.

Poem

I nudge a link with a twitch of my nose,
Hop—now to Getting Started it goes!
A card, a copy, commands in tow,
Docs bloom like carrots in tidy rows.
Thump-thump! New trails in UI land—
Follow my paws, with button in hand. 🥕✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 662e77d and 1c4417c.

📒 Files selected for processing (3)

• app/docs/getting-started/page.tsx (1 hunks)
• app/page.tsx (1 hunks)
• config/nav-items.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/getting-started-page

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbit 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:
  • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
8bitcn-ui	Ready	Preview	Comment	Aug 28, 2025 10:08am