chore(web): improve docs and readme

[AmanVarshney01]

Summary by CodeRabbit

• New Features

  • Added extensive new documentation for CLI commands, project structure, configuration, compatibility rules, analytics, and contributing.
  • Introduced a visual Stack Builder tool and documented its usage.

• Documentation

  • Major overhaul and expansion of Quick Start and index documentation with new philosophy, usage examples, and categorized feature lists.
  • Added detailed CLI command docs with usage instructions, flags, examples, and compatibility notes.
  • Provided high-level project structure diagrams for different stack presets.
  • Added guides for configuration files, analytics/telemetry, compatibility, and contributing.
  • Simplified and condensed the FAQ for easier reference.
  • Updated repository links to the new GitHub URL.
  • Removed outdated or redundant installation and CLI command reference docs.

• Bug Fixes

  • Corrected GitHub URLs in the footer, navbar, and analytics header components.

• Refactor

  • Centralized and streamlined CLI compatibility and validation logic, improving maintainability and error messaging.
  • Improved project path validation for CLI project creation.

• Chores

  • Updated documentation metadata and navigation structure for clarity and easier access to key resources.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 342bddd

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]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a major documentation overhaul, centralizes and modularizes CLI compatibility validation logic, and refactors several CLI prompt and utility files for maintainability. New documentation pages are added, others are removed or condensed, and compatibility rules are moved into a dedicated module. Minor bug fixes and URL updates are also included.

Changes

Cohort / File(s)	Change Summary
Documentation Overhaul apps/web/content/docs/index.mdx, apps/web/content/docs/meta.json, apps/web/content/docs/faq.mdx, apps/web/content/docs/project-structure.mdx, apps/web/content/docs/compatibility.mdx, apps/web/content/docs/bts-config.mdx, apps/web/content/docs/analytics.mdx, apps/web/content/docs/contributing.mdx, apps/web/content/docs/cli/index.mdx, apps/web/content/docs/cli/init.mdx, apps/web/content/docs/cli/add.mdx, apps/web/content/docs/cli/builder.mdx, apps/web/content/docs/cli/docs.mdx, apps/web/content/docs/cli/sponsors.mdx, apps/web/content/docs/cli/meta.json	Major rewrite and expansion of documentation: new quick start, philosophy, project structure, compatibility, analytics, config, and contributing docs; CLI command docs split into individual files; metadata updated.
Documentation Removals apps/web/content/docs/installation.mdx, apps/web/content/docs/cli-commands.mdx	Deletion of installation and CLI command reference docs, replaced by new, more focused documentation.
CLI Prompt & Utility Refactor apps/cli/src/prompts/api.ts, apps/cli/src/prompts/examples.ts, apps/cli/src/prompts/frontend.ts, apps/cli/src/prompts/project-name.ts, apps/cli/src/prompts/web-deploy.ts, apps/cli/src/utils/generate-reproducible-command.ts, apps/cli/src/types.ts	Refactored prompts to use new compatibility utilities; improved path validation; reordered package manager logic; removed/updated type aliases and constants.
CLI Compatibility Logic Centralization apps/cli/src/validation.ts, apps/cli/src/utils/compatibility-rules.ts, apps/cli/src/utils/compatibility.ts	All compatibility and validation logic moved to new utility modules; validation functions now invoked from CLI flag processing; new compatibility utility for web frameworks.
Constant Relocation apps/cli/src/constants.ts	Removal of WEB_FRAMEWORKS constant, now relocated to a new utility module.
CLI & Docs README Updates README.md, apps/cli/README.md	Expanded philosophy, features, usage, and contribution instructions in main and CLI READMEs; reordered package manager recommendations; updated URLs.
Web App URL and Banner Updates apps/web/src/app/(home)/_components/footer.tsx, apps/web/src/app/(home)/_components/navbar.tsx, apps/web/src/app/(home)/analytics/_components/analytics-header.tsx, apps/web/src/app/docs/layout.tsx	Updated GitHub URLs; removed "work in progress" banner from docs layout.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant CompatibilityUtils
    participant Docs

    User->>CLI: Run CLI command with flags or prompts
    CLI->>CompatibilityUtils: Validate flag and prompt combinations
    CompatibilityUtils-->>CLI: Return validation result or error
    CLI-->>User: Proceed with project creation or show error
    User->>Docs: Read updated documentation for guidance

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

• #427: Adds fumadocs, ultracite, oxlint addons—directly related to changes in CLI prompt logic and compatibility utilities.
• #476: Refactors CLI compatibility logic and documentation, closely mirroring the modularization and relocation of constants/utilities in this PR.
• #326: Introduces Cloudflare Workers runtime support, which is now validated and managed by the new compatibility utility functions.

Poem

A rabbit with docs and a stack to refine,
Hopped through the code, making validation align.
Docs now are clearer, the CLI more wise,
Compatibility rules in one cozy surprise.
URLs are updated, the banners are gone—
This stack’s ready for builders to hop right on! 🐇✨

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51cfb35 and 342bddd.

⛔ Files ignored due to path filters (1)

• bun.lock is excluded by !**/*.lock

📒 Files selected for processing (34)

• README.md (2 hunks)
• apps/cli/README.md (4 hunks)
• apps/cli/src/constants.ts (0 hunks)
• apps/cli/src/prompts/api.ts (2 hunks)
• apps/cli/src/prompts/examples.ts (2 hunks)
• apps/cli/src/prompts/frontend.ts (2 hunks)
• apps/cli/src/prompts/project-name.ts (3 hunks)
• apps/cli/src/prompts/web-deploy.ts (1 hunks)
• apps/cli/src/types.ts (1 hunks)
• apps/cli/src/utils/compatibility-rules.ts (1 hunks)
• apps/cli/src/utils/compatibility.ts (1 hunks)
• apps/cli/src/utils/generate-reproducible-command.ts (1 hunks)
• apps/cli/src/validation.ts (7 hunks)
• apps/web/content/docs/analytics.mdx (1 hunks)
• apps/web/content/docs/bts-config.mdx (1 hunks)
• apps/web/content/docs/cli-commands.mdx (0 hunks)
• apps/web/content/docs/cli/add.mdx (1 hunks)
• apps/web/content/docs/cli/builder.mdx (1 hunks)
• apps/web/content/docs/cli/docs.mdx (1 hunks)
• apps/web/content/docs/cli/index.mdx (1 hunks)
• apps/web/content/docs/cli/init.mdx (1 hunks)
• apps/web/content/docs/cli/meta.json (1 hunks)
• apps/web/content/docs/cli/sponsors.mdx (1 hunks)
• apps/web/content/docs/compatibility.mdx (1 hunks)
• apps/web/content/docs/contributing.mdx (1 hunks)
• apps/web/content/docs/faq.mdx (1 hunks)
• apps/web/content/docs/index.mdx (1 hunks)
• apps/web/content/docs/installation.mdx (0 hunks)
• apps/web/content/docs/meta.json (1 hunks)
• apps/web/content/docs/project-structure.mdx (1 hunks)
• apps/web/src/app/(home)/_components/footer.tsx (2 hunks)
• apps/web/src/app/(home)/_components/navbar.tsx (1 hunks)
• apps/web/src/app/(home)/analytics/_components/analytics-header.tsx (1 hunks)
• apps/web/src/app/docs/layout.tsx (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 trying-gpt-5

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai 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 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

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

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.