Skip to content

Module-Level Traceability Strategies #16

@avrabe

Description

@avrabe

Based on analysis of eclipse-score/docs-as-code, we should explore implementing module-level traceability strategies similar to their approach to handle circular references while maintaining build integrity.

Key concepts from their implementation:

  1. Module-level references can be circular (bi-directional links between modules)
  2. Bazel target dependencies must remain acyclic
  3. They use two strategies:
    • Build-with-links: Fast builds with hyperlinks to external documentation (forward links only)
    • Build-with-copies: Self-contained release documentation with embedded content (includes backward links)
  4. Their system separates module-level references (which can be circular) from Bazel target dependencies (which must be acyclic)

We should consider implementing similar strategies in Rivet to handle:

  • Circular traceability references between modules/components
  • Different traceability report types (development vs release)
  • Performance optimization for large traceability graphs
  • Strategies for handling version dependencies in traceability links

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions