Commit 2b2d34b
docs(0.2.0): close 27 doc-audit findings (release-blockers + should-fix)
Comprehensive sweep through public-facing docs after the v0.2.0
release-readiness audit. Covers everything flagged across the four
parallel review domains: README + top-level repo files, product
narrative, release-shape docs (parity rubric/scores, known-gaps,
release notes), and adopter-facing user-guides + schema + examples.
Release-blocking fixes:
- README.md, CONTRIBUTING.md: Tier-1 floor "≥ 4" → "≥ 3 in 0.2.0
(≥ 4 in 0.3 once labeled-corpus precision floor lands)"; matches
rubric.yaml's actual gate.
- CONTRIBUTING.md: "10 canonical commands" → "11" (matches binary).
Removed two references to non-existent
`docs/release/0.2.x-maturity-audit.md`. Expanded exit-code
documentation to cover the full 0/1/2/4/5/6 scheme.
- docs/product/ai-trust-boundary.md (lines 75-94) + ai-risk-tiers.md
(line 101): rewritten away from the non-existent flags
`terrain ai run --baseline / --ingest-only / --promptfoo-results`.
Now documents the actual 0.2 escape hatch — `terrain analyze`
with `--promptfoo-results / --deepeval-results / --ragas-results`
for ingesting pre-computed eval JSON without invoking any
framework, plus `terrain ai record` + `terrain ai baseline
compare` for regression-aware gating.
- docs/product/vision.md (primitives table): clarified that
`--new-findings-only --baseline` is an analyze flag; the gate
flow is `terrain analyze --fail-on=...`.
- docs/examples/gate/github-action.yml: rewrote the recommended
GitHub Action template — `--new-findings-only --baseline` now
on the `analyze` step (where the flag actually exists);
`terrain report pr` is just the comment renderer. The previous
template would have failed on first run with "flag provided but
not defined: -new-findings-only".
- docs/schema/analysis.schema.json: replaced the stale `1.0.0`
schema (which described meta/summary/files top-level keys that
haven't existed since the analyze rewrite) with a permissive
stub pinned to `schemaVersion: "1"` and pointing at
`internal/analyze/analyze.go::Report` as the canonical source.
Includes one-line descriptions for all real top-level keys
emitted by `terrain analyze --json` today.
- docs/schema/portfolio.md: TestAsset and Finding shapes
regenerated against `internal/portfolio/model.go` —
`paths` → `path` + `relatedPaths`; `confidence` is a string
enum (`high`/`moderate`/`low`), not a float; dropped fictional
`severity` and `coverageRatio`; added missing `testType`,
`breadthClass`, `passRate`, `retryRate`, `coveredModules`,
`ownersCovered`, `importedSources`, `instabilitySignals`,
`hasRuntimeData`, `hasCoverageData`, `metadata`.
- docs/examples/serve-local-dev.md: default port 7344 → 8421;
removed non-existent `--snapshot` flag; added `--host`
example.
Should-fix cleanup:
- README.md, CHANGELOG.md, vision.md: dropped `focus` from the
`terrain report` verb list (the canonical surface has summary,
insights, metrics, explain, show, impact, pr, posture,
select-tests — `focus` is a legacy top-level alias only).
- README.md, CONTRIBUTING.md, DESIGN.md: package count
47/49 → 53.
- docs/cli-spec.md: surface table rebuilt against `terrain --help`
output — 11 canonical commands (analyze, init, report, migrate,
ai, debug, config, doctor, portfolio, serve, version), correct
per-namespace verb lists, and a one-paragraph note on legacy
aliases.
- docs/release/parity/rubric.yaml: removed dead reference to
`0.2.x-maturity-audit.md`; ai_eval_ingestion surface string
updated to use the real `terrain ai record / baseline compare`
workflow.
- docs/release/parity/scores.yaml score-evidence corrections:
- core_analyze.E1 5 → 4 (no `func Fuzz*` tests in repo;
adversarial fixtures sit at the level-3↔5 midpoint)
- core_analyze.E4 evidence updated — the `FIELD_TIERS.md` doc
closes the previously-claimed "no tier markers" gap
- summary_posture_metrics_focus.P7 5 → 4 (level-5 anchor
"composes with neighbouring tools cleanly" is partial)
- policy_governance.E4 4 → 3 — previous evidence cited the
wrong schema doc (`eval-adapters.md` is for AI eval
adapters, not policy); honest level-3 anchor now noted
- docs/release/0.2-known-gaps.md: rows 29/31/41 reclassified from
"0.3 deferred" to "(fixed in 0.2)" with code pointers — the
`pairedConfidence` ramp, the `aiHallucinationRate` keyword
expansion, and the `aiModelDeprecationRisk` comment-prefix
expansion all shipped in 0.2.
- docs/release/feature-status.md: `terrain compare` row marked
experimental (matches the "output format may shift" caveat
later in the file). Added a one-line orphan-signal pointer
surfacing the 15 long-standing structural / quality / migration
/ governance signals carried over from 0.1.x — truth-verify
now reviews 44 signals instead of 29.
- docs/release/0.2.md: replaced the unmet "P50 < 10s on 10k-file
repo" Tier-2 gate with the actual measured budget contract
(per-stage timing visible via --verbose; bench-gate enforces
no >10% regression vs `benchmarks/baseline.txt`; published
per-size-class budgets land in 0.3).
- docs/release/quality-bar-and-gates.md: `make js-release-verify`
→ `make npm-release-verify` (the actual Makefile target name).
- docs/release/supply-chain.md: corrected the Homebrew formula
description — it's a source-build formula updated by the
`homebrew-update.yml` workflow, not generated by goreleaser.
- docs/release/release-checklist-final.md: `report focus` removed
from the smoke list; `report select-tests` and `report impact`
added (matches actual canonical verb list).
- docs/glossary.md: posture entry corrected — five real
dimensions (health, coverage_depth, coverage_diversity,
structural_risk, operational_risk) and real bands instead of
the wrong "reliability/change-readiness/speed/governance/AI"
+ A/B/C/D vocabulary.
- docs/product/terrain-overview.md: stale "22 signal types" /
count-based framings replaced with order-of-magnitude prose
("70+ signal types") + a pointer to the auto-generated
manifest. Canonical 11-command CLI surface re-stated.
- docs/user-guides/ui-triage-flow.md: posture dimensions
corrected to match `posture-model.md`.
- docs/user-guides/writing-a-policy.md: removed the false claim
that `terrain init` writes `.terrain/policy.yaml`; the real
workflow is to copy a template from `docs/policy/examples/`.
- docs/user-guides/ai-eval-onboarding.md: expected `terrain ai
list` output replaced with the actual current shape.
- docs/user-guides/impact-analysis-and-test-selection.md: `--base`
default `main` → `HEAD~1` (matches binary).
- docs/schema/pr-analysis.md: `scope` example corrected — real
fields are `baselineRef` / `currentRef` (not
`baseRef` / `headRef`); `changedFiles` is `[]ChangedFile`
objects with `path` + `changeKind` + `isTestFile`, not bare
strings.
Verification:
- make pillar-parity → understand=3 PASS, gate=3 PASS, align WARN soft
- make truth-verify → 44 documented signals all resolve (was 29)
- make docs-verify → manifest + rubric stubs in sync
- make docs-linkcheck → all intra-repo links resolve
- make voice-lint → clean
- make release-gate → all snapshot tests pass
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent b924d4e commit 2b2d34b
27 files changed
Lines changed: 382 additions & 259 deletions
File tree
- docs
- examples
- gate
- product
- release
- parity
- schema
- user-guides
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
| |||
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
118 | | - | |
| 118 | + | |
119 | 119 | | |
120 | 120 | | |
121 | 121 | | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
122 | 128 | | |
123 | 129 | | |
124 | 130 | | |
125 | 131 | | |
126 | 132 | | |
127 | 133 | | |
128 | | - | |
129 | | - | |
130 | | - | |
| 134 | + | |
131 | 135 | | |
132 | 136 | | |
133 | 137 | | |
| |||
138 | 142 | | |
139 | 143 | | |
140 | 144 | | |
141 | | - | |
142 | | - | |
143 | | - | |
| 145 | + | |
| 146 | + | |
144 | 147 | | |
145 | 148 | | |
146 | 149 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
41 | | - | |
| 40 | + | |
| 41 | + | |
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
253 | 253 | | |
254 | 254 | | |
255 | 255 | | |
256 | | - | |
| 256 | + | |
257 | 257 | | |
258 | 258 | | |
259 | 259 | | |
| |||
262 | 262 | | |
263 | 263 | | |
264 | 264 | | |
265 | | - | |
| 265 | + | |
266 | 266 | | |
267 | 267 | | |
268 | 268 | | |
| |||
616 | 616 | | |
617 | 617 | | |
618 | 618 | | |
619 | | - | |
| 619 | + | |
620 | 620 | | |
621 | 621 | | |
622 | 622 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
30 | 32 | | |
31 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
32 | 38 | | |
33 | 39 | | |
34 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | | - | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
62 | 69 | | |
63 | 70 | | |
64 | 71 | | |
| 72 | + | |
| 73 | + | |
65 | 74 | | |
| 75 | + | |
66 | 76 | | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
78 | 82 | | |
79 | 83 | | |
80 | 84 | | |
81 | 85 | | |
82 | | - | |
83 | | - | |
84 | 86 | | |
85 | | - | |
86 | 87 | | |
87 | 88 | | |
88 | 89 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
35 | 38 | | |
36 | 39 | | |
37 | 40 | | |
38 | 41 | | |
39 | | - | |
40 | | - | |
| 42 | + | |
| 43 | + | |
41 | 44 | | |
42 | 45 | | |
43 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
47 | 55 | | |
48 | 56 | | |
49 | 57 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
102 | 104 | | |
103 | 105 | | |
104 | 106 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
81 | 101 | | |
82 | 102 | | |
83 | 103 | | |
84 | 104 | | |
85 | 105 | | |
86 | 106 | | |
| 107 | + | |
87 | 108 | | |
88 | 109 | | |
89 | 110 | | |
90 | 111 | | |
91 | | - | |
92 | | - | |
93 | | - | |
94 | | - | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
95 | 118 | | |
96 | 119 | | |
97 | 120 | | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
103 | 130 | | |
104 | 131 | | |
105 | 132 | | |
| |||
0 commit comments