Context
Post-wave-audit finding #15 (see docs/v1-rc1-post-wave-audit.md).
Strikethrough resolved-in-issue blocks in docs were useful during the wave (showed reviewers the issue was tracked) but are noise after the issues close.
Examples:
Fix
At v1.0-rc1 tag time (right before tagging), sweep all ~~...~~ strikethrough blocks in docs/ where the referenced issue is closed. Replace with a single-line "Resolved by #N — landed in vX.Y.Z" or delete entirely.
Acceptance
grep -rn '~~' docs/ returns either no hits or hits that strikethrough open / actively-relevant text.
- One-paragraph commit message documenting the sweep.
Trigger
Run at RC1 tag-cut time, not before (the strikes are still informative until the tag).
Context
Post-wave-audit finding #15 (see
docs/v1-rc1-post-wave-audit.md).Strikethrough resolved-in-issue blocks in docs were useful during the wave (showed reviewers the issue was tracked) but are noise after the issues close.
Examples:
docs/patterns/10-cuda-oom-deceptive.md:74—~~DCGM_FI_DEV_FB_*OTTL recipe extension.~~block referencing closed [rc1-prep] OTTL recipe: project DCGM_FI_DEV_FB_USED/FB_FREE → hw.gpu.memory.{free,total} log shape (pattern #10 wiring) #337.docs/v1-rc1-simplification-audit.md:185-186—~~components/exporters/otlphttp/~~+~~components/exporters/stdoutexporter/~~referencing closed [rc1-prep] Delete in-tree components/exporters/otlphttp/ wrapper (superseded by upstream otlphttpexporter) #333 / [rc1-prep] Delete in-tree components/exporters/stdoutexporter/ wrapper (superseded by upstream debugexporter) #334.Fix
At v1.0-rc1 tag time (right before tagging), sweep all
~~...~~strikethrough blocks indocs/where the referenced issue is closed. Replace with a single-line "Resolved by #N — landed in vX.Y.Z" or delete entirely.Acceptance
grep -rn '~~' docs/returns either no hits or hits that strikethrough open / actively-relevant text.Trigger
Run at RC1 tag-cut time, not before (the strikes are still informative until the tag).