Skip to content

docs: revamp org profile as a product family overview - #36

Merged
shenxianpeng merged 7 commits into
mainfrom
docs/org-profile-readme
Jul 27, 2026
Merged

docs: revamp org profile as a product family overview#36
shenxianpeng merged 7 commits into
mainfrom
docs/org-profile-readme

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 27, 2026

Copy link
Copy Markdown
Member

Present Commit Check as a cohesive product family with a clear value proposition, the CLI/Action/MCP/App lineup, key features, and trust signals (SLSA Level 3, notable adopters, license).

Summary by CodeRabbit

  • Documentation
    • Reorganized and refreshed the project overview with clearer sections covering benefits, capabilities, security, and community involvement.
    • Added prominent branding and status, license, and documentation badges.
    • Expanded descriptions of enforcement, AI governance, shared configuration, reporting, JSON output, and MCP tools.
    • Added information about provenance, adoption, licensing, and project maintenance.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 50 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 Plus

Run ID: 50a434f7-1d04-4367-86da-8e8a054a4d33

📥 Commits

Reviewing files that changed from the base of the PR and between 3fe0868 and 2b899f5.

📒 Files selected for processing (1)
  • profile/README.md
📝 Walkthrough

Walkthrough

The profile README was substantially rewritten with a centered branded header, additional badges, new sections describing Commit Check products and features, security information, and reorganized community links.

Changes

Profile README

Layer / File(s) Summary
README branding and content rewrite
profile/README.md
Replaces the opening layout and informational sections with new branding, badges, product details, feature descriptions, security information, and a reorganized “Get involved” section.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README revamp and its new product-family positioning.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/org-profile-readme

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.

@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown

Commit-Check ❌

--- PR Title:
Type subject_imperative check failed ==> docs: revamp org profile as a product family overview 
Commit message should use imperative mood (e.g., 'fix bug' not 'fixed bug', 'add feature' not 'adding feature')
Suggest: Change the first verb to imperative form, e.g., 'fix' instead of 'fixed'/'fixes'/'fixing' 

--- Commit 1/7:
Type subject_imperative check failed ==> docs: revamp org profile as a product family overview 
Commit message should use imperative mood (e.g., 'fix bug' not 'fixed bug', 'add feature' not 'adding feature')
Suggest: Change the first verb to imperative form, e.g., 'fix' instead of 'fixed'/'fixes'/'fixing' 

--- Commit 2/7:
Type subject_imperative check failed ==> chore: Comment out commit-check-app entry in README 
Commit message should use imperative mood (e.g., 'fix bug' not 'fixed bug', 'add feature' not 'adding feature')
Suggest: Change the first verb to imperative form, e.g., 'fix' instead of 'fixed'/'fixes'/'fixing' 
Commit rejected by Commit-Check.                                  
                                                                  
  (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)  
   / ._. \      / ._. \      / ._. \      / ._. \      / ._. \   
 __\( C )/__  __\( H )/__  __\( E )/__  __\( C )/__  __\( K )/__ 
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
   || E ||      || R ||      || R ||      || O ||      || R ||   
 _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._ 
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
 `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´ 
                                                                  
Commit rejected.                                                  
                                                                  
Type branch check failed ==> docs/org-profile-readme 
The branch should follow Conventional Branch. See https://conventionalbranch.org
Suggest: Use <type>/<description> with allowed types or add branch name to allow_branch_names in config, or use ignore_authors in config branch section to bypass

Present Commit Check as a cohesive product family with a clear value
proposition, the CLI/Action/MCP/App lineup, key features, and trust signals
(SLSA Level 3, notable adopters, license).
Commented out the commit-check-app entry in the README.
Updated logo size in README.md from 110 to 200 pixels.
Updated logo image size in README.
Updated logo size in README from 400px to 300px.
Updated logo size in README from 300 to 200 pixels.
@shenxianpeng
shenxianpeng force-pushed the docs/org-profile-readme branch from 0d6498d to 2b899f5 Compare July 27, 2026 07:22
@shenxianpeng
shenxianpeng merged commit 8f70b14 into main Jul 27, 2026
1 of 2 checks passed
@shenxianpeng
shenxianpeng deleted the docs/org-profile-readme branch July 27, 2026 07:23
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant