Skip to content

docs(specs): correct stale references, broken links, and formatting - #6629

Merged
bug-ops merged 1 commit into
mainfrom
fix/specs-quality-audit
Jul 21, 2026
Merged

docs(specs): correct stale references, broken links, and formatting#6629
bug-ops merged 1 commit into
mainfrom
fix/specs-quality-audit

Conversation

@bug-ops

@bug-ops bug-ops commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary

Audit of the entire /specs/ tree against the sdd skill's own review checklist (correctness vs. current code, completeness of mandatory sections, internal consistency, formatting). No source code is touched, only files under specs/.

  • Fixed ~40 stale crate/module paths, type names, and enum variants that no longer matched crates/ (feature flags, MSRV, crate count, provider registry layout, TACO description in the agent-loop spec)
  • Added 24 missing rows to the MOC-specs.md status tracker and restored omitted child-spec entries in 004-memory/spec.md
  • Fixed ~90 broken [[wikilink]] cross-references (shifted spec numbers, links to nonexistent slugs)
  • Repaired a broken markdown code fence in 031-database-abstraction/spec.md that silently swallowed roughly 2500 lines of the document as an unclosed code block, plus duplicate heading numbers in three other files
  • Reconciled 004-memory/ sub-specs on GitHub org, migration numbers, implementation status, and component naming

Flagged, not executed (need follow-up)

  • Seven MCP/security sub-specs (008-mcp/008-1..3, 010-security/010-1..4) reference types with no match anywhere in the codebase — need a dedicated rewrite session against real code, not a text patch
  • 031-database-abstraction/spec.md (2958 lines) has an independent ~900-line subsystem (agent identity data isolation) embedded with no external references — candidate for extraction to its own spec
  • 013-acp/spec.md still asserts an outdated protocol version in several current-state sections
  • ARCHITECTURE.md's dependency graph only covers specs 001-034; specs 035-081 are not represented
  • 004-16 spec-number collision between two files (blocked on existing rustdoc citations in source, see issue specs/README.md spec-number index drifted from actual specs/ directory names #6308)

Test plan

  • gitleaks protect --staged — no leaks found
  • Verified fence-parity across all /specs/ markdown files after the fence repair
  • Verified wikilink resolver reports only the intentional TEMPLATE.md placeholder as unresolved
  • No Rust build/test/clippy/rustdoc gate applies — zero .rs files changed

…cross /specs

Audit all specification files under /specs/ for correctness against the
current codebase, completeness of mandatory sections, and internal
consistency, per the sdd skill's review checklist.

- fix stale crate/module paths, type names, and enum variants across ~40
  spec files that no longer matched crates/ (feature flags, MSRV, crate
  count, provider registry layout, TACO/orchestration descriptions)
- add 24 missing rows to the MOC-specs.md status tracker and restore
  omitted child-spec entries in 004-memory/spec.md
- fix ~90 broken [[wikilink]] cross-references (shifted spec numbers,
  links to nonexistent slugs)
- repair a broken markdown code fence in 031-database-abstraction/spec.md
  that silently swallowed roughly 2500 lines of the document as an
  unclosed code block, plus duplicate heading numbers in three other files
- reconcile 004-memory/ sub-specs on GitHub org, migration numbers,
  implementation status, and component naming
- flag (without rewriting) seven MCP/security sub-specs whose types have
  no match anywhere in the codebase, and flag a 2900-line spec with an
  independent 900-line subsystem embedded that should be split out
@bug-ops
bug-ops force-pushed the fix/specs-quality-audit branch from 31574a8 to 79b6a28 Compare July 21, 2026 00:58
@bug-ops
bug-ops enabled auto-merge (squash) July 21, 2026 00:58
@bug-ops
bug-ops merged commit 83639de into main Jul 21, 2026
23 checks passed
@bug-ops
bug-ops deleted the fix/specs-quality-audit branch July 21, 2026 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XL Extra large PR (500+ lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant