Skip to content

Commit a29ed35

Browse files
shenxianpengshenxianpeng
committed
chore: simplify projects page, remove redundant content
- Remove project cards duplicated from home page - Remove release history table (hard to keep current) - Remove quick links section (duplicates Getting Started) - Focus on architecture diagram and surface comparison table
1 parent 0287bb7 commit a29ed35

1 file changed

Lines changed: 30 additions & 79 deletions

File tree

‎docs/projects.md‎

Lines changed: 30 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -5,86 +5,37 @@ hide:
55

66
# Projects
77

8-
The Commit Check ecosystem consists of three open-source projects that work
9-
together to enforce commit quality standards across your entire workflow.
10-
11-
<div class="grid cards" markdown>
12-
13-
- :fontawesome-brands-python: __commit-check__
14-
15-
---
16-
17-
**The core engine.** A Python CLI and library for validating commit
18-
messages, branch names, author identity, sign-off trailers, push safety,
19-
and AI attribution.
20-
21-
- Latest release: **v2.11.0**
22-
- Highlights: AI attribution governance, message patterns, JSON output,
23-
Python API
24-
- Works as: CLI tool, pre-commit hooks, importable library
25-
26-
[:octicons-arrow-right-24: GitHub](https://github.com/commit-check/commit-check)
27-
[:octicons-arrow-right-24: Docs](https://commit-check.github.io/commit-check/)
28-
29-
- :material-github: __commit-check-action__
30-
31-
---
32-
33-
**GitHub Action** that wraps the core engine into a seamless CI step.
34-
Validates PR commits and posts results as check runs, job summaries, and
35-
PR comments.
36-
37-
- Latest release: **v2.10.0**
38-
- Highlights: Windows runner support, PR title validation, PR comments
39-
- Works as: GitHub Action in your workflows
40-
41-
[:octicons-arrow-right-24: GitHub](https://github.com/commit-check/commit-check-action)
42-
[:octicons-arrow-right-24: Docs](https://github.com/commit-check/commit-check-action?tab=readme-ov-file#usage)
43-
44-
- :material-robot: __commit-check-mcp__
45-
46-
---
47-
48-
**MCP Server** that exposes commit-check validations as structured tools
49-
for AI coding agents like Claude Code, Cursor, and Copilot.
50-
51-
- Latest release: **v0.1.7**
52-
- Highlights: AI attribution governance sync, message pattern support,
53-
push safety validation, MCP Registry published
54-
- Works as: MCP server in your AI agent's config
55-
56-
[:octicons-arrow-right-24: GitHub](https://github.com/commit-check/commit-check-mcp)
57-
[:octicons-arrow-right-24: MCP Registry](https://registry.mcpx.dev)
58-
59-
</div>
60-
61-
## How they fit together
8+
The commit-check ecosystem is built on a simple architecture: **one policy engine,
9+
multiple enforcement surfaces.** Write your `cchk.toml` once — every surface
10+
reads the same file.
6211

6312
```mermaid
64-
graph LR
65-
A[commit-check<br/>Python Core] --> B[commit-check-action<br/>GitHub Action]
66-
A --> C[commit-check-mcp<br/>MCP Server]
67-
B --> D[CI Pipeline]
68-
C --> E[AI Coding Agent]
13+
graph TB
14+
subgraph Policy["📄 cchk.toml"]
15+
direction LR
16+
Config[One policy file]
17+
end
18+
19+
subgraph Engine["⚙️ commit-check<br/>(Python core)"]
20+
direction LR
21+
CLI[CLI & pre-commit]
22+
API[Python API]
23+
end
24+
25+
subgraph Surfaces["🚀 Enforcement surfaces"]
26+
Action[commit-check-action<br/>GitHub Action]
27+
MCP[commit-check-mcp<br/>MCP Server]
28+
end
29+
30+
Config --> Engine
31+
CLI --> Action
32+
API --> MCP
33+
Action --> CI[CI Pipeline]
34+
MCP --> Agent[AI Coding Agent]
6935
```
7036

71-
The same `cchk.toml` policy file drives **all three** — write it once, enforce
72-
it everywhere.
73-
74-
## Release history
75-
76-
| Project | Latest | Recent updates |
77-
|---------|--------|----------------|
78-
| commit-check | v2.11.0 | AI attribution governance, message patterns, JSON output |
79-
| commit-check-action | v2.10.0 | Windows runner, PR title validation |
80-
| commit-check-mcp | v0.1.7 | AI attribution sync, message patterns, MCP Registry |
81-
82-
## Quick links
83-
84-
| What do you need? | Use this |
85-
|-------------------|----------|
86-
| Validate commits in CI | [commit-check-action](https://github.com/commit-check/commit-check-action) |
87-
| Validate commits locally | [commit-check CLI](https://github.com/commit-check/commit-check) |
88-
| Validate commits via pre-commit | [commit-check hooks](https://commit-check.github.io/commit-check/example.html#running-as-pre-commit-hook) |
89-
| Let AI agents auto-comply | [commit-check-mcp](https://github.com/commit-check/commit-check-mcp) |
90-
| Configure policy once | [`cchk.toml` reference](https://commit-check.github.io/commit-check/configuration.html) |
37+
| Surface | What it does | Get started |
38+
|---------|-------------|-------------|
39+
| **commit-check** | CLI tool, pre-commit hooks, and Python library. The core engine that runs all validations. | [`commit-check/commit-check`](https://github.com/commit-check/commit-check) |
40+
| **commit-check-action** | GitHub Action wrapping the core engine. Posts results as check runs, job summaries, and PR comments. | [`commit-check/commit-check-action`](https://github.com/commit-check/commit-check-action) |
41+
| **commit-check-mcp** | MCP server that exposes validations as structured tools for AI coding agents (Claude Code, Cursor, Copilot, etc.). | [`commit-check/commit-check-mcp`](https://github.com/commit-check/commit-check-mcp) |

0 commit comments

Comments
 (0)