From 389a7c9c9ad46726d7bed8603861b4e42f23c348 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Aug 2026 16:09:51 +0000 Subject: [PATCH] docs: stop the ecosystem diagram drawing local checks as a dead end MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The diagram gave the Action and the MCP server an endpoint each — CI Pipeline, AI Coding Agent — but the CLI and pre-commit node had only one outgoing edge, to the Action. The place the page elsewhere calls the cheapest and most important ("the check that runs in CI is the same one that runs in your commit-msg hook") was drawn as a dead end inside the engine box. It also mixed levels: Config pointed at a subgraph while CLI pointed out of one, so the arrows were not comparable. Now one config, one engine, three surfaces, three places they run — symmetric, and the local path arrives somewhere. Verified with the real mermaid parser rather than by eye: 8 nodes and 7 edges, matching the source. The previous version parsed and rendered correctly too, so this changes what the picture claims, not whether it draws. Dropping the CLI-versus-Python-API split loses no accuracy that matters here — the Action does shell out to the CLI and the MCP server does import commit_check.engine, but which of the two a surface uses is a contributor's question, not a landing page's. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn --- docs/index.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/docs/index.md b/docs/index.md index e14d360..7e3699b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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
(Python core)"] - direction LR - CLI[CLI & pre-commit] - API[Python API] - end - - subgraph Surfaces["🚀 Enforcement surfaces"] - Action[commit-check-action
GitHub Action] - MCP[commit-check-mcp
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"] ```