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

[shenxianpeng]

What

The last structural item from the review. It turned out to be a modelling problem rather than the "this diagram is heavier than it earns" I had it down as.

The local path was drawn as a dead end

The diagram gave the Action and the MCP server an endpoint each, but the CLI and pre-commit node had exactly one outgoing edge — to the Action:

Config --> Engine
CLI    --> Action        ← CLI's only outgoing edge
API    --> MCP
Action --> CI            ← endpoint
MCP    --> Agent         ← endpoint

So the picture showed commit-check reaching CI and an AI agent, and never reaching a developer — while the prose a few hundred pixels above says the opposite:

the check that runs in CI is the same one that runs in your commit-msg hook, where a malformed subject costs a second to fix rather than a full CI cycle and a force-push

It also mixed levels: Config pointed at a subgraph while CLI pointed out of one, so the arrows were not comparable to each other.

Now

One config, one engine, three surfaces, three places they run. Symmetric, and the local path arrives somewhere.

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"]

Loading

On what was dropped

The old diagram split the engine into CLI & pre-commit and Python API, and both edges were accurate — I checked rather than assumed. commit-check-action shells out to the CLI (run_commit_check() in its main.py), and commit-check-mcp imports the engine directly:

from commit_check.engine import ValidationContext, ValidationEngine, CheckOutcome
from commit_check.config_merger import deep_merge, get_default_config, load_toml_config
from commit_check.rules_catalog import BRANCH_RULES, COMMIT_RULES, PUSH_RULES

Which of the two a surface consumes is a contributor's question, though, not a landing page's — so the split is gone and no claim went with it.

Test plan

• mkdocs build --strict clean; 8 tests pass
• Diagram validated with the real mermaid parser (11.16.1) in a headless DOM rather than by eye — mermaid.parse() then render(), giving 8 nodes and 7 edges, matching the source
• The previous version was put through the same check and parsed and rendered correctly too (5 edges, as declared) — so this changes what the picture claims, not whether it draws

Note

Material loads mermaid from a CDN that the proxy here blocks, so the diagram does not render in my local build. That is why it was validated against the mermaid library directly. Worth a glance at the deploy preview to confirm it draws in place.

With this, the review list is down to one item: the "Trusted by" wording, which needs your judgement on real-world usage rather than mine.

Separately, the --compact naming inconsistency from that list is now filed upstream as commit-check/commit-check#528 — it is a change to commit-check, not to this site.

---

Generated by Claude Code

Summary by CodeRabbit

• Documentation
  • Simplified the Ecosystem diagram to clearly illustrate how configuration flows through the core engine and integrates with command-line tools, automation, and AI coding workflows.

[netlify]

✅ Deploy Preview for commit-check ready!

Name	Link
🔨 Latest commit	389a7c9
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check/deploys/6a7363001e5be10008f6a75c
😎 Deploy Preview	https://deploy-preview-10--commit-check.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 675c7c17-f222-4fd9-8ca5-822cb6c32951

📥 Commits

Reviewing files that changed from the base of the PR and between b52eace and 389a7c9.

📒 Files selected for processing (1)

• docs/index.md

---

📝 Walkthrough

Walkthrough

The documentation replaces the grouped ecosystem Mermaid diagram with a simpler left-to-right flow from cchk.toml through the core engine and integrations to developer, CI, and AI-agent destinations.

Changes

Ecosystem diagram

Layer / File(s)	Summary
Replace ecosystem flow docs/index.md	The Mermaid diagram now connects cchk.toml to the core engine, CLI/pre-commit hook, GitHub Action, MCP server, laptop, CI pipeline, and AI coding agent.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly addresses the primary change: replacing the ecosystem diagram to eliminate the depiction of local checks as a dead end.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/refresh-sample-output-602anc

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}