docs: sync README + FEATURES.md to one source of truth#36
Merged
Conversation
Reviewer flagged numerical inconsistency between README and FEATURES.md.
Audit confirmed:
- FEATURES.md was internally inconsistent: header line said
"337 features · 73 skills · 1023 tests" but Summary table totalled
"367 features · 74 skills · 1023 tests"
- README badges + body cited stale pre-Phase-3 numbers
(60 skills, 405 tests, 75+ endpoints, v2.1 engine, 50+ MCP skills)
- Some claims were under-counts vs ground truth (260+ features,
53.3K LOC, 60+ files, 10+ services, 22 test files)
This commit aligns BOTH docs to verified ground truth as of 2026-05-03:
Canonical fact set:
367 features (FEATURES.md per-section sum, structural)
74 skills (`ls skills/*.py` excluding __init__, tracked)
940+ tests (947 currently collected; "+" leaves headroom)
58K+ LOC (production code only, excluding tests/)
135+ API endpoints (@router decorators in routes/ + dashboard)
15 PM2 services (`name:` entries in ecosystem.config.js)
230+ Python files (production tree, no tests/scratch/docs)
53 test files (`ls tests/test_*.py`)
CODEC v2.3 (current engine version)
README changes (10 lines):
- 4 badges (features/skills/tests/lines)
- "v2.1" → "v2.3" in product brand callout
- 3 occurrences of "60 skills" → "74 skills" (Core row, body, screenshot)
- "75+ API endpoints" → "135+" (Dashboard intro, file table)
- "50+ pluggable" → "74" (MCP section)
- "60+ files" → "230+" (Cursor row)
- "60 built-in skills" → "74", "405 tests" → "940+" (file tree, contrib)
- "10+ services" → "15" (file tree)
- "405 pytest tests across 22 files" → "940+ across 53 files"
FEATURES.md changes (2 lines):
- Line 3 header: 337 → 367 features, 73 → 74 skills, 1023 → 940+ tests,
"53K+ lines of code" → "58K+ lines of production code"
- Line 506 summary: same fact-set alignment
No prose, structure, or framing changed. Pure number sync — same speech
across both files.
Note: skills/file_write.py is untracked in main; tracked count is 74.
A separate task tracks deciding whether to commit or remove it.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reviewer flagged that README and FEATURES.md tell two different stories. Audit found:
337 features · 73 skills · 1023 tests, summary table totalled367 features · 74 skillsThis PR aligns both docs to one verified fact set, derived from the filesystem:
ls skills/*.pyexcluding__init__(tracked)pytest --collect-only= 947 today;+leaves headroomwc -lexcludingtests/and.claude/@router.*inroutes/+codec_dashboard.pyname:entries inecosystem.config.jsls tests/test_*.pyWhat changed
FEATURES.md— 2 lines (header + summary block, same fact set in both)README.md— 10 lines: 4 badges, v2.1→v2.3 in product callout, 3× "60 skills" → 74, "75+ endpoints" → 135+ (×2), "50+ pluggable" → 74, "60+ files" → 230+, "10+ services" → 15, "405 tests across 22 files" → "940+ across 53 files".No prose touched. No structure changed. No framing edited. Pure number sync.
Sidebar
skills/file_write.pyis untracked in main but exists on disk — explains whyls skills/*.pyreturned 75 outside the worktree but 74 inside it. A separate task tracks deciding whether to commit (real skill) or delete (orphan). Not blocking this PR.Test plan
grep -nE "60[ +]skill|73[ +]skill|50\+ pluggable|405 test|1023 test|260\+|337 |60\+ files|75\+ endpoint|10\+ services|53\.3K"returns 0 hits in README/FEATURES🤖 Generated with Claude Code