docs: fix stale claims found by full-repo audit - #83
Merged
Merged
Conversation
Every doc audited against the code; 14 confirmed defects fixed: - README: sales depth is six layers, not three; examples paragraph reformatted as per-language bullets (was a 12-line run-on sentence) - CLAUDE.md: contracted-seam list gains LanguageAdapter (13 contracts, not 12) — the old list would make an agent skip the blast-radius gate on the adapter seam; hosted-store theme is v0.5 (renumbered), not v0.3 - benchmarks: reproducibility attribution was inverted (hashloom side is exact, raw side drifts with runner output); 12→13 contracts; 2-3→2-6 layers - demo: storyboard edited src/revenue.py which doesn't exist — the unit lives in src/metrics.py; followed verbatim, scene 6 would show cached-pass instead of the cold pass the demo depends on - hosted-store: two 'not yet' claims describe shipped behavior (CLI/MCP wiring, server-side ran_at stamping) — rewritten as history/shipped - sales README: included_sales has fourteen dependents, not twelve - CHANGELOG: [Unreleased] records the graphify importer - ROADMAP: 0.1.0 shipped to PyPI as heddle-mcp, not hashloom - ISSUES: tracker links point at davet47/hashloom; item 7 tells the rename story instead of present-tense heddle
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
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.
Every doc audited against the code; 14 confirmed defects fixed:
What and why
Checklist
uv run pytestpasses (full suite).contract.pyorimplhash.py? The hash-stability tests(
tests/test_contract_hash.py,tests/test_implhash.py) still pass, andany change to what busts a hash is intentional.
uv run python bench/benchmark.pystill reports >5x.
was discussed in an issue first.
HashloomError); no stack traces over MCP.