Skip to content

[High] Add a Documentation-to-Test Traceability Matrix #687

Description

@levi0005

Description: Build a matrix mapping every documented behavioral guarantee in docs/*.md (e.g. "listing can be cancelled while funding is in progress is now prevented" per docs/IMPROVEMENTS.md) to the specific test(s) that verify it, surfacing any documented guarantee with no corresponding test.
Context: Documentation and tests drift apart over time by default; without an explicit traceability check, a "documented but untested" gap can persist indefinitely and give false confidence to anyone reading the docs.
Scope & Acceptance Criteria: A matrix (markdown table, generated or hand-built) covering at minimum docs/CONTRACTS.md, docs/invoice-nft.md, docs/marketplace.md, docs/financing-pool.md, docs/treasury.md, docs/risk-registry.md, docs/access-control.md, and docs/governance.md; any guarantee found with no corresponding test either gets one added (if small) or is filed as a follow-up (if larger). Out of scope: auditing non-behavioral documentation (e.g. README.md's marketing-style overview).
Implementation: Key files: all files under docs/, contracts/tests/. Edge cases: guarantees that are true "by construction" (e.g. enforced by the Rust type system) rather than by a runtime check — note these as "type-enforced" rather than flagging as an untested gap. Testing: this issue's deliverable is the matrix itself; any newly-added tests it prompts are verified normally.



Complexity: High (200 points)
Program: Drips "Stellar Wave"

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions