Skip to content

Commit fbbfa56

Browse files
committed
chore(docs): polishing documentation
1 parent fdec2af commit fbbfa56

2 files changed

Lines changed: 3 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ sync SPDX headers.
2222
split — all without changing canonical report schema until the later `2.2` report-threshold update below.
2323
- `cache.effective_freshness` marker and `get_production_triage` / `codeclone://latest/triage` for compact
2424
production-first overview.
25-
- `compare_runs` now reports `mixed` when new regressions and `health_delta` point in opposite directions.
26-
- `compare_runs` now reports `incomparable` and omits `health_delta` when run roots or effective analysis settings do not match.
27-
- MCP summary/triage/health surfaces now mark `health` as unavailable in `clones_only` runs instead of emitting zeroed placeholders.
25+
- Honest run comparison: `compare_runs` reports `mixed` / `incomparable` instead of misleading single verdicts;
26+
`clones_only` runs surface `health: unavailable` instead of zeroed placeholders.
2827
- Fix hotlist key resolution for `production_hotspots` and `test_fixture_hotspots`.
2928
- Bump cache schema to `2.3` (stale metric entries rebuilt, not reused).
3029

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ CodeClone provides deterministic structural code quality analysis for Python.
2222
It detects architectural duplication via normalized AST and Control Flow Graphs,
2323
computes quality metrics, and enforces CI gates — all with **baseline-aware
2424
governance** that separates **known** technical debt from **new** regressions.
25-
An optional read-only MCP interface exposes the same analysis pipeline to AI agents, IDEs, and other MCP-capable
26-
clients.
25+
An optional MCP interface exposes the same pipeline to AI agents and IDEs.
2726

2827
Docs: [orenlab.github.io/codeclone](https://orenlab.github.io/codeclone/) ·
2928
Live sample report:
@@ -170,9 +169,6 @@ codeclone-mcp --transport streamable-http --port 8000
170169
20 tools + 10 resources — deterministic, baseline-aware, and read-only. Never mutates source files, baselines, or repo
171170
state.
172171
Payloads are optimised for LLM context: compact summaries by default, full detail on demand.
173-
Run comparison stays compact too: `compare_runs` reports `mixed` when finding deltas and run-to-run health move in
174-
opposite directions, and `incomparable` when roots or effective analysis settings differ.
175-
When metrics are skipped (`clones_only`), MCP marks `health` as unavailable instead of returning fake zeros.
176172

177173
Docs:
178174
[MCP usage guide](https://orenlab.github.io/codeclone/mcp/)

0 commit comments

Comments
 (0)