Repository navigation
Commit 406e9b8
authored
docs: lead the home page with commit policy as code for teams and AI agents (#51)
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.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>1 parent 8ac62e8 commit 406e9b8
2 files changed
Lines changed: 5 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
0 commit comments