ADR 029 Read Only Documentation Diagnostics - joeroberts/release-radar GitHub Wiki

  • ID: ADR-029
  • Status: Accepted
  • Date: 2026-09-09
  • Date meaning: Original dated decision/source section; extraction recorded 2026-10-02.
  • Implementation: No implementation information was recorded in the source status; tickets own progress.
  • Approval qualification: Authorized bounded source contract; installed adoption, consumer changes and runtime pilot remain separately authorized.

Context

A bounded documentation diagnostic reports contract compatibility without accepting or mutating managed documentation state.

Decision

The local source candidate adds diagnose --root <exact-root> --format json to ReleaseRadarDocumentationTool. Existing check, write and help behavior is preserved. The diagnostic envelope uses format com.rekonlabs.release-radar.documentation-check-result, schema version 1, and checker.contractVersion 1. It reports checker tool version/build and supported catalog versions, target repository/catalog identity, passed or failed status and a structured error. Unavailable optional values are explicit JSON nulls; unknown or unstable identity is never invented.

Diagnosis uses the existing bounded, exact-root documentation checks and performs no acceptance, binding, evidence relocation or persistence mutation. The shared compatibility observation consumes this result through existing authorization and generation boundaries. A passed diagnostic is not owner adoption, content approval, an execution attestation or catalog acceptance. Guidance v3 remains separately reserved; installation, consumer changes and runtime pilot remain unauthorized.

⚠️ **GitHub.com Fallback** ⚠️