From 3f9664cc3c72de237952a9a309b93636debee7a5 Mon Sep 17 00:00:00 2001 From: Frank Scholter Peres Date: Mon, 13 Apr 2026 12:01:26 +0000 Subject: [PATCH 1/2] docs(traceability): align dashboards with coverage metrics --- .../requirements/implementation_state.rst | 38 +++++++++++++++++-- docs/internals/requirements/requirements.rst | 16 ++++++++ 2 files changed, 50 insertions(+), 4 deletions(-) diff --git a/docs/internals/requirements/implementation_state.rst b/docs/internals/requirements/implementation_state.rst index 580e090fc..c74567bde 100644 --- a/docs/internals/requirements/implementation_state.rst +++ b/docs/internals/requirements/implementation_state.rst @@ -19,13 +19,23 @@ Implementation State Statistics Overview -------- +.. note:: + **Implementation vs. Traceability:** A requirement can be "implemented" in code + without having documentation links. This dashboard shows implementation status. + + - **Not implemented**: ``implemented == 'NO'`` (actual TODO) + - **Implemented but incomplete docs**: ``implemented == 'YES|PARTIAL'`` and missing source_code_link OR missing testlink + - **Fully documented**: Both ``source_code_link`` and ``testlink`` present + + The CI/CD gate check enforces minimum coverage thresholds for source_code_link and testlink. + .. needpie:: Requirements Status - :labels: not implemented, implemented but not tested, implemented and tested + :labels: not implemented, implemented (at least partial), fully documented :colors: red,yellow, green type == 'tool_req' and implemented == 'NO' - type == 'tool_req' and testlink == '' and (implemented == 'YES' or implemented == 'PARTIAL') - type == 'tool_req' and testlink != '' and (implemented == 'YES' or implemented == 'PARTIAL') + type == 'tool_req' and (implemented == 'YES' or implemented == 'PARTIAL') and (source_code_link == '' or testlink == '') + type == 'tool_req' and (implemented == 'YES' or implemented == 'PARTIAL') and source_code_link != '' and testlink != '' In Detail --------- @@ -45,13 +55,33 @@ In Detail .. grid-item-card:: - .. needpie:: Requirements with Codelinks + .. needpie:: Requirements with Source Code Links :labels: no codelink, with codelink :colors: red, green type == 'tool_req' and source_code_link == '' type == 'tool_req' and source_code_link != '' + .. grid-item-card:: + + .. needpie:: Requirements with Test Links + :labels: no testlink, with testlink + :colors: red, green + + type == 'tool_req' and testlink == '' + type == 'tool_req' and testlink != '' + + .. grid-item-card:: + + .. needpie:: Full Traceability (Code + Test Links) + :labels: fully linked, code only, test only, unlinked + :colors: green, orange, yellow, red + + type == 'tool_req' and source_code_link != '' and testlink != '' + type == 'tool_req' and source_code_link != '' and testlink == '' + type == 'tool_req' and source_code_link == '' and testlink != '' + type == 'tool_req' and source_code_link == '' and testlink == '' + .. grid-item-card:: .. needpie:: Test Results diff --git a/docs/internals/requirements/requirements.rst b/docs/internals/requirements/requirements.rst index dd5d8baa5..05e98a77c 100644 --- a/docs/internals/requirements/requirements.rst +++ b/docs/internals/requirements/requirements.rst @@ -731,6 +731,22 @@ Architecture Attributes 🔗 Code Linkage ---------------- +**Codelink Coverage Status** + +.. needpie:: Tool Requirements with Source Code Links + :labels: with codelink, without codelink + :colors: green, red + + type == 'tool_req' and source_code_link != '' + type == 'tool_req' and source_code_link == '' + +.. note:: + This dashboard is complemented by an automated CI check using + ``traceability_coverage``. + The checker enforces minimum coverage thresholds. See + :doc:`/how-to/test_to_doc_links` for detailed information on combining + visual dashboards with CI/CD gates. + .. tool_req:: Supports linking to source code :tags: Detailed Design & Code :id: tool_req__docs_dd_link_source_code_link From e022e122b81d69439b9d14a8e311ffb43a0d17c5 Mon Sep 17 00:00:00 2001 From: Frank Scholter Peres Date: Mon, 13 Apr 2026 13:55:11 +0000 Subject: [PATCH 2/2] fix lint --- docs/internals/requirements/implementation_state.rst | 4 ++-- docs/internals/requirements/requirements.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/internals/requirements/implementation_state.rst b/docs/internals/requirements/implementation_state.rst index c74567bde..d574fbda8 100644 --- a/docs/internals/requirements/implementation_state.rst +++ b/docs/internals/requirements/implementation_state.rst @@ -22,11 +22,11 @@ Overview .. note:: **Implementation vs. Traceability:** A requirement can be "implemented" in code without having documentation links. This dashboard shows implementation status. - + - **Not implemented**: ``implemented == 'NO'`` (actual TODO) - **Implemented but incomplete docs**: ``implemented == 'YES|PARTIAL'`` and missing source_code_link OR missing testlink - **Fully documented**: Both ``source_code_link`` and ``testlink`` present - + The CI/CD gate check enforces minimum coverage thresholds for source_code_link and testlink. .. needpie:: Requirements Status diff --git a/docs/internals/requirements/requirements.rst b/docs/internals/requirements/requirements.rst index 05e98a77c..4337d916a 100644 --- a/docs/internals/requirements/requirements.rst +++ b/docs/internals/requirements/requirements.rst @@ -741,9 +741,9 @@ Architecture Attributes type == 'tool_req' and source_code_link == '' .. note:: - This dashboard is complemented by an automated CI check using + This dashboard is complemented by an automated CI check using ``traceability_coverage``. - The checker enforces minimum coverage thresholds. See + The checker enforces minimum coverage thresholds. See :doc:`/how-to/test_to_doc_links` for detailed information on combining visual dashboards with CI/CD gates.