docs: rewrite Getting Started as a step-by-step guide#12
Conversation
Replace the placeholder landing-page-style getting-started with a comprehensive step-by-step guide that covers: - Installation (pip, Homebrew, pre-commit, MCP) - First check with zero configuration - Configuration file setup (cchk.toml, priority, org-level) - Pre-commit hooks setup - CI/CD integration (GitHub Actions, GitLab CI, generic) - AI agent / MCP setup - Next steps reference Fixes the biggest gap in the documentation site: a practical onboarding path from zero to fully configured.
✅ Deploy Preview for commit-check-github-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 54 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
Rewrite the Getting Started page from a placeholder with just link cards to a comprehensive step-by-step guide that actually walks users from zero to fully configured.
Before
The page was essentially a landing page with four card buttons linking to external resources — no actual guidance, no installation steps, no example commands.
After
The new guide has 6 numbered sections:
cchk.tomlcreation, config priority, org-level inheritancePlus a Next Steps reference table connecting to all other docs pages.
Related
Addresses the documentation quality gap identified in GAP_ANALYSIS_REPORT.md — specifically the 'documentation site content is thin' issue.