Skip to content

docs: archive 17 stale planning docs to docs/historical/ (REQ-074 Phase 2a)#308

Merged
avrabe merged 1 commit into
mainfrom
chore/pr-c-docs-archive
May 20, 2026
Merged

docs: archive 17 stale planning docs to docs/historical/ (REQ-074 Phase 2a)#308
avrabe merged 1 commit into
mainfrom
chore/pr-c-docs-archive

Conversation

@avrabe
Copy link
Copy Markdown
Contributor

@avrabe avrabe commented May 20, 2026

Summary

Wave 1 / PR-C of the cross-git investigation follow-ups (FEAT-135).
Acts on the ARCHIVE verdicts from DOC-DOCS-AUDIT-2026-05-19 — a third
of the docs/ tree was dead-letter planning material next to active
reference docs.

  • 17 files git mv'd to docs/historical/ (history preserved):
    15 docs/plans/2026-03-*.md implementation plans for long-shipped
    work, docs/audit-report.md (a 2026-03-09 snapshot superseded by
    the new audit), and docs/design/rivet-cli-gaps-2026-04.md.
  • Kept in docs/plans/: oslc-analysis.md (KEEP verdict) and the
    two vscode-lsp-rendering files (INVESTIGATE — need triage).
  • doc_check: docs/historical/ joins plans//design/ as an
    auto-is_design_doc dir, so frozen archive snapshots don't trip the
    existence-based invariants. New unit test.
  • The one real inbound markdown link (what-is-rivet.md) is repointed
    and annotated as superseded.

Test plan

  • rivet docs check — PASS (57 files, 0 violations).
  • cargo clippy -p rivet-core -- -D warnings — exit 0.
  • historical_dir_is_design_doc_without_marker unit test passes.

Refs: FEAT-135, REQ-073, REQ-074

🤖 Generated with Claude Code

…se 2a)

Wave 1 / PR-C of the cross-git investigation follow-ups. Acts on the
ARCHIVE verdicts from the docs audit (DOC-DOCS-AUDIT-2026-05-19):
roughly a third of the docs/ tree was dead-letter planning material
sitting next to active reference docs.

Moved to docs/historical/ (17 files, all `git mv` — history preserved):
  - 15 docs/plans/2026-03-*.md — implementation plans for work that
    has long since shipped (commit-traceability, cross-repo linking,
    rowan/salsa, baseline-scoped validation, LSP, formal-verification
    completion, the v0.1.0 release plan, ...).
  - docs/audit-report.md — a 2026-03-09 doc-vs-reality snapshot that
    still claimed fuzz/mutation testing "NOT IMPLEMENTED" while CI
    runs both. Superseded by docs/research/2026-05-19-docs-audit.md.
  - docs/design/rivet-cli-gaps-2026-04.md — a gap list with most
    items now shipped.

Kept in docs/plans/: oslc-analysis.md (audit verdict KEEP — explains
a deliberate non-shipping decision still in force) and the two
vscode-lsp-rendering files (audit verdict INVESTIGATE — need a
maintainer triage, not archival).

doc_check change: `docs/historical/` joins `docs/plans/` and
`docs/design/` as an auto-`is_design_doc` directory. A frozen
archive snapshot legitimately references subcommands, artifact
counts, and IDs that have since changed; without the exemption the
moved files would trip the existence-based doc-check invariants
(SubcommandReferences / ArtifactCounts / ArtifactIdValidity). New
unit test `historical_dir_is_design_doc_without_marker`.

The one real inbound markdown link (what-is-rivet.md → audit-report)
is repointed to the new path and annotated as superseded.

Verified: `rivet docs check` PASS (57 files, 0 violations);
`cargo clippy -p rivet-core -- -D warnings` exit 0; the new unit
test passes.

Refs: FEAT-135, REQ-073, REQ-074

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

📐 Rivet artifact delta

No artifact changes in this PR. Code-only changes (renderer, CLI wiring, tests) don't touch the artifact graph.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Rivet Criterion Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: db2ed75 Previous: 9909beb Ratio
traceability_matrix/1000 62499 ns/iter (± 245) 45259 ns/iter (± 4967) 1.38
query/10000 132344 ns/iter (± 735) 99824 ns/iter (± 437) 1.33

This comment was automatically generated by workflow using github-action-benchmark.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@avrabe avrabe merged commit 0d98b7c into main May 20, 2026
19 of 39 checks passed
@avrabe avrabe deleted the chore/pr-c-docs-archive branch May 20, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant