Antora Tracer — Self-Traceability Example

Antora Tracer

    • Overview
    • Tutorial
      • Getting Started
    • How-to Guides
      • Set up
        • Set up traceability for a new project
        • Define a custom domain model
      • Author items
        • Write traceable items
        • Use partial files with items
        • Supersede an item
      • Maintain & verify
        • Detect and resolve duplicate item IDs
        • Lint prose with Vale
      • Query & export
        • Query the graph from the command line
        • Export to Neo4j
        • Diff two versions of your docs
      • Publish
        • Add traceability visualizations
        • Index traceable items in site search
        • Generate DOCX output
        • Show the build version in the footer
        • Serve the site with Docker
    • ID Allocation Server
      • Run the server
    • Skills
      • Install the agent skills
      • Evaluate the agent skills
    • Reference
      • Item Macro
      • Traceability Macros
      • Configuration
      • Presets
      • CLI
      • API
      • Documentation Style Guide
    • Explanation
      • The Traceability Model
      • Our Traceability Model
      • Processing Pipeline
      • Architecture
      • Product Structure
      • Architecture Decisions
      • Quality Attributes
      • Comparison with Sphinx Needs
      • Antora vs Sphinx — Pipelines
    • Self-Traceability
      • Use Cases
      • Requirements
      • Test Plan
      • Delivery Process
      • Dashboard
    • Traceability
      • Overview
      • Traceability Overview
      • UC → Req
      • Req → Design
      • Req → Tests
      • Process → Design
    • Project
      • Contribute to the project
      • Troubleshoot common issues
Antora Tracer main
  • Antora Tracer
    • main
    • 0.25
    • 0.24
  • Blog
    • 0.1
  • Demo
    • main
  • Tracer Spec Workflow
  • Antora Tracer
  • Explanation
  • Architecture Decisions
main 0.25 0.24
Edit this Page

Architecture Decision Records

This section documents the architectural decisions that shaped the Antora Tracer extension. Each record follows the MADR template.

  • ADR-001 — ESM over CommonJS

  • ADR-002 — Regex-based parsing over AST

  • ADR-003 — In-memory graph over persisted database

  • ADR-004 — Zero framework dependencies

  • ADR-005 — TypeScript strict mode and Node.js 20+

  • ADR-006 — DFS-based circular reference detection

  • ADR-007 — Partial files — Pass 1 only

  • ADR-008 — Assembled document output via asciidoctor docbook pipeline

  • ADR-009 — Requirements are superseded, never mutated

  • ADR-010 — Identity-first graph diff over rename detection

  • ADR-011 — Relations with a mandatory reverse and canonical primary storage

  • ADR-012 — CLI owns source mutation; the extension stays read-only

  • ADR-013 — Pin PDF/assembler extensions to beta.20 for Antora 3.1 compatibility

  • ADR-014 — Derive the component version from the git refname

  • ADR-015 — Deferred relationship canonicalization

  • ADR-016 — Tenant-scoped ID prefix settings

This page was built using the antora-ui-conemso theme

Built from 3191517.

Source: branch/main@https://github.com/rattermeyer/antora-tracer.git(3191517dfda3f25d43856740b82dc065155a48d3)

The source code for this UI is licensed under the terms of the MPL-2.0 license.