docs: reconcile README/site claims with verified artifacts (E2 claim-audit, R5)#121
Merged
Conversation
…audit, R5)
Line-by-line audit of every capability claim in README.md and site/ against its
backing artifact. Verified-correct and left as-is: 1.06 s / 1.99 s freshness
(docs/freshness-benchmark.md), 6 metrics + 2.5 s p95 staleness budget
(config/contracts/metric.*.v1.yaml), 38 DV2 tables = 8 hubs / 8 links / 22 sats
(dv2-multi-branch/architecture.md + demo_evidence.md), 3 dbt marts, all 42
referenced doc/script paths exist, and v1.5.0 published on PyPI + npm (confirmed
via live registry query).
Fixed the drift the audit found:
- README: "12 required status checks" -> "13" and added build-smoke to the list
(branch protection's required_status_checks has 13 contexts, build-smoke was
missing from the prose); "960+ unit tests" -> "1,500+" (1501 verified this
cycle); dropped the budget-framing "paid" from the Scope non-goal
("rather than a paid managed cloud" -> "rather than a managed cloud").
- site/index.html: the performance-baseline panel (56 / 260 / 330 ms, 27.8 RPS,
0%) cited docs/benchmark-baseline.json, which has since been regenerated with
CI-runner numbers (140 / 610 / 23000 ms). Re-pointed the source to
docs/release-readiness.md, which holds that exact aggregate run (569 requests,
0 failures).
- docs/dv2-multi-branch/RELEASE_STATUS.md (the artifact the "v1.5_published"
README badge links to): refreshed from v1.4.0 to v1.5.0 — header, status line
(verified 2026-06-30 via live registries), registry table rows, tag-state row,
and re-verify pins. PyPI agentflow-runtime/agentflow-client 1.5.0 and npm
@yuliaedomskikh/agentflow-client 1.5.0, tag c99d094. Full v1.5.0 release
mechanics remain for the formal release cut (E1).
Verify: doc-coupled tests (test_examples, test_release_artifacts,
test_contract_dependencies) green; no code touched.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
DORA Metrics
|
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.
What
E2 claim-audit (road-to-9.8 R5): a line-by-line pass over every capability claim in
README.mdandsite/, checking each maps to a runnable test/artifact, with non-goals stated without budget-framing.Verified-correct (left as-is)
docs/freshness-benchmark.md(measured arms)catalog.py(6MetricDefinition) +config/contracts/metric.*.v1.yaml(p95_staleness_budget_seconds: 2.5)dv2-multi-branch/architecture.md+demo_evidence.mdwarehouse/.../dbt/models/marts/agentflow-runtime/agentflow-client/@yuliaedomskikh/agentflow-clientall1.5.0Fixed drift
12required status checks →13+ addedbuild-smoke(branch protection'srequired_status_checkshas 13 contexts; the prose was missing one).960+unit tests →1,500+(1501 verified). Dropped budget-framingpaidfrom the Scope non-goal (rather than a paid managed cloud→a managed cloud).docs/benchmark-baseline.json, which has since been regenerated with CI-runner numbers (140 / 610 / 23000 ms). Re-pointed the source todocs/release-readiness.md, which holds that exact aggregate run (569 requests, 0 failures).v1.5_publishedREADME badge links to) — was stale at v1.4.0; refreshed to v1.5.0 (header, status line verified 2026-06-30 via live registries, registry-table rows, tag-state row, re-verify pins; tagc99d094). Full v1.5.0 release mechanics remain for the formal release cut (E1).Verify
Doc-coupled tests green (
test_examples,test_release_artifacts,test_contract_dependencies); no code touched. Remaining residual drift out of this PR's README/site scope:docs/glossary.mdcarries the same stalebenchmark-baseline.jsoncitation (noted for a later docs pass).🤖 Generated with Claude Code