Skip to content

docs: lead the home page with commit policy as code for teams and AI agents - #51

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp
Oct 8, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Before: the home page said what Commit Check checks but never what it is. The meta description opened with "Catch bad commits before they merge." The site description opened with "Enforce commit message, branch naming, author and signoff standards".

After:

  • The hero's lede opens with a bold Commit policy as code for teams and AI agents. The headline above it is unchanged.
  • The home page's meta description opens with the same line.
  • The site description opens with it too.

How: this changes three strings in docs/index.md and mkdocs.yml. The search title stays "Commit message & branch name linter for Git", because that is what people search for.

Checks:

  • mkdocs build --strict passes. Social cards were off for that build, since Google Fonts is unreachable from the build machine.
  • python -m pytest tests/ passes against commit-check 2.18.3, which is the latest release on PyPI. Pins and changelog are already in step.
  • Screenshots of the built hero at 1280px and 390px wide show the bold line leading the lede with no wrapping problems.

Companion PRs put the same line at the front of the org profile, the Action and the MCP server.

🤖 Generated with Claude Code

https://claude.ai/code/session_013rE6bouKaJvsRyKA4tjqCb


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the site description and homepage messaging to position Commit Check as policy-as-code for teams and AI agents.
    • The messaging now highlights standards for commit messages, branch names, authors, and sign-offs, enforced through hooks, CI, and pull requests. It retains the existing details about validation and reporting.

…agents

The hero's first sentence, the home page's meta description and the
site description now carry the line the project is putting at the front
of its public copy. The headline and the search title stay: people
still search for a commit message linter.
@netlify

netlify Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 5295bd4
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6ac6b9193649f00008be5bf3
😎 Deploy Preview https://deploy-preview-51--commit-check.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 Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 49ca42f2-04f9-4720-88f0-9ca395c99beb
📥 Commits

Reviewing files that changed from the base of the PR and between 8ac62e8 and 5295bd4.

📒 Files selected for processing (2)
  • docs/index.md
  • mkdocs.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The site description and homepage copy now present Commit Check as policy as code for teams and AI agents. The copy lists validation standards and enforcement locations.

Changes

Policy-as-code positioning

Layer / File(s) Summary
Update site and homepage descriptions
mkdocs.yml, docs/index.md
The site description and homepage copy describe Commit Check as policy as code for teams and AI agents. The copy lists commit message, branch naming, author, and sign-off standards and names hooks, CI, and pull requests as enforcement locations.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 5295b

The updated descriptions are supported by the documented agent integration, including configured sign-off checks. No material merge risk remains.

🚥 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 and concisely describes the main documentation change: positioning Commit Check as policy-as-code for teams and AI agents.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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 added the documentation Improvements or additions to documentation label Oct 8, 2026
@shenxianpeng
shenxianpeng merged commit 406e9b8 into main Oct 8, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-pofwgp branch October 8, 2026 04:49
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