Skip to content

docs: rewrite Getting Started as a step-by-step guide#12

Closed
shenxianpeng wants to merge 1 commit into
mainfrom
docs/improve-getting-started
Closed

docs: rewrite Getting Started as a step-by-step guide#12
shenxianpeng wants to merge 1 commit into
mainfrom
docs/improve-getting-started

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

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:

  1. Install — Four installation methods: pip, Homebrew, pre-commit, MCP Server
  2. Run Your First Check — Zero-config validation with stdin, file, and branch examples
  3. Add a Configuration Filecchk.toml creation, config priority, org-level inheritance
  4. Set Up Pre-commit Hooks — All 5 hooks documented with installation instructions
  5. Set Up CI/CD — GitHub Actions, GitLab CI, and generic platform guidance
  6. Set Up for AI Coding Agents (MCP) — Claude Desktop, Claude Code CLI, AI Attribution policy

Plus 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.

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.
@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for commit-check-github-io ready!

Name Link
🔨 Latest commit b5f0c98
🔍 Latest deploy log https://app.netlify.com/projects/commit-check-github-io/deploys/6a4fe2948533280008da894e
😎 Deploy Preview https://deploy-preview-12--commit-check-github-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@shenxianpeng, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: caad9017-c0d3-4709-81f7-048bf6288216

📥 Commits

Reviewing files that changed from the base of the PR and between 760a762 and b5f0c98.

📒 Files selected for processing (1)
  • docs/getting-started.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/improve-getting-started

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

Comment @coderabbitai help to get the list of available commands.

@shenxianpeng shenxianpeng deleted the docs/improve-getting-started branch July 9, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant