Skip to content

docs: stop the ecosystem diagram drawing local checks as a dead end #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Aug 5, 2026
+10 −22
Merged

docs: stop the ecosystem diagram drawing local checks as a dead end #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 10 additions & 22 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,28 +195,16 @@ One policy engine, multiple enforcement surfaces. Write your `cchk.toml` once
every surface reads the same file.

```mermaid
graph TB
subgraph Policy["📄 cchk.toml"]
direction LR
Config[One policy file]
end

subgraph Engine["⚙️ commit-check<br/>(Python core)"]
direction LR
CLI[CLI & pre-commit]
API[Python API]
end

subgraph Surfaces["🚀 Enforcement surfaces"]
Action[commit-check-action<br/>GitHub Action]
MCP[commit-check-mcp<br/>MCP Server]
end

Config --> Engine
CLI --> Action
API --> MCP
Action --> CI[CI Pipeline]
MCP --> Agent[AI Coding Agent]
graph LR
Config["cchk.toml"] --> Engine["commit-check"]

Engine --> Hook["CLI and pre-commit hook"]
Engine --> Action["commit-check-action"]
Engine --> MCP["commit-check-mcp"]

Hook --> Dev["Your laptop"]
Action --> CI["CI pipeline"]
MCP --> Agent["AI coding agent"]
```

<div class="grid cards" markdown>
Expand Down