File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -9,37 +9,30 @@ The commit-check ecosystem is built on a simple architecture: **one policy engin
99multiple enforcement surfaces.** Write your ` cchk.toml ` once — every surface
1010reads the same file.
1111
12- <div class =" grid cards " markdown >
13-
14- - :material-file-document-outline: ** One policy: ` cchk.toml ` **
15-
16- ---
17-
18- Write your rules once, enforce everywhere.
19-
20- ↓
21-
22- - :fontawesome-brands-python: ** commit-check** (core engine)
23-
24- ---
25-
26- CLI · pre-commit · Python API
27-
28- ↓
29-
30- - :material-github: ** commit-check-action**
31-
32- ---
33-
34- GitHub Action → CI Pipeline
35-
36- - :material-robot: ** commit-check-mcp**
37-
38- ---
39-
40- MCP Server → AI Coding Agent
41-
42- </div >
12+ ``` mermaid
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]
35+ ```
4336
4437| Surface | What it does | Get started |
4538| ---------| -------------| -------------|
Original file line number Diff line number Diff line change @@ -56,7 +56,11 @@ theme:
5656
5757
5858markdown_extensions :
59- - pymdownx.superfences
59+ - pymdownx.superfences :
60+ custom_fences :
61+ - name : mermaid
62+ class : mermaid
63+ format : !!python/name:pymdownx.superfences.fence_code_format
6064 - attr_list
6165 - md_in_html
6266 - pymdownx.tabbed :
You can’t perform that action at this time.
0 commit comments