Skip to content

DO NOT MERGE - preview: requirement reference-coverage pies + gap tables (docs-as-code#896 + #921) - #384

Closed
antonkri wants to merge 7 commits into
mainfrom
preview/docs-reference-coverage
Closed

antonkri wants to merge 7 commits into
mainfrom
preview/docs-reference-coverage

Conversation

@antonkri

@antonkri antonkri commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

DO NOT MERGE. Preview-only pin of score_docs_as_code so the generated
documentation can be reviewed before the upstream PRs are merged.

Pinned to 9dbca09, the tip of docs-as-code's feat/requirement-reference-gap-tables.
That branch is stacked directly on feat/requirement-reference-coverage, so this single
commit carries both open PRs:

PR What you see in the generated docs
docs-as-code#896 "Reference Coverage" pie charts in the platform verification report: how many stakeholder requirements are referenced by feature requirements, and how many feature requirements are referenced by component requirements. Scoped to the report's report_version.
docs-as-code#921 Collapsible "Not referenced by ..." tables directly under each pie, listing exactly which requirements make up the red slice (id, title, safety, status). Collapsed by default, so the report stays readable.

Where to look

Platform Verification Report:

  • Stakeholder Requirements section - pie + Not referenced by feature requirements (n) dropdown.
  • Each feature section - pie + Not referenced by component requirements (n) dropdown.

Why both in one preview

#921 only adds the drill-down for the gaps that #896's pies already report, so reviewing
them separately would mean looking at half a feature. Pinning the stacked tip shows the
end result as it will land once both are merged.

Temporarily overrides score_docs_as_code to
eclipse-score/docs-as-code@6767751 (branch feat/requirement-reference-coverage,
PR docs-as-code#896) to preview the requirement reference-coverage pie
charts and the "Referenced by" table column added to
platform_verification_report via the reference_integration docs build.

Revert once verified, or once docs-as-code#896 merges and the known_good
pin is updated normally.
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

Points the preview at the tip of docs-as-code's
feat/requirement-reference-gap-tables branch.

That branch is stacked directly on feat/requirement-reference-coverage,
so this single commit carries the changes of both open PRs:

  * docs-as-code#896 - reference-coverage pie charts for stakeholder and
    feature requirements, report-version scoped.
  * docs-as-code#921 - collapsible tables listing exactly which
    requirements make up the "not referenced" slice of each pie.

DO NOT MERGE - preview pin only.
@antonkri antonkri changed the title DO NOT MERGE - preview: requirement reference-coverage pie charts (docs-as-code#896) DO NOT MERGE - preview: requirement reference-coverage pies + gap tables (docs-as-code#896 + #921) Oct 7, 2026
@antonkri antonkri closed this Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant