docs: add documentation impact to acceptance audit - #154
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Merged
Conversation
Contributor
| \nThis PR is currently a draft.\n\nThe auto-merge automation will not merge draft pull requests. |
El-swaggerito
marked this pull request as ready for review
July 29, 2026 09:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Extends the existing canonical acceptance-criteria completion table with a
Documentation Impact field. This keeps one audit system while making every
criterion identify affected documents or an explicit
N/Awith a reason.Changed files:
docs/traceability-mapping.md— adds the field, examples, definitions, andincomplete-criteria guidance;
.github/PULL_REQUEST_TEMPLATE.md— collects documentation impact for everycriterion;
CONTRIBUTING.md— makes the field part of the required contributor flow;docs/evaluation-readiness.md— updates the central table example; anddocs/pr-evidence-checklist.md— adds documentation impact to PR evidenceand maintainer review guidance.
Related Issues
Fixes #143
Completion Table
docs/traceability-mapping.mdand.github/PULL_REQUEST_TEMPLATE.md; no duplicate template addeddocs/traceability-mapping.md,.github/PULL_REQUEST_TEMPLATE.mddocs/traceability-mapping.mdCONTRIBUTING.md.github/PULL_REQUEST_TEMPLATE.md,CONTRIBUTING.md,docs/pr-evidence-checklist.mdDetailed Traceability Mapping
Not applicable. This documentation/template-only patch does not change storage,
events, or security controls; the existing detailed table is preserved.
Type of Change
PR Evidence Checklist
1. Issue Reference
2. Implementation Summary
3. Tests Added or Justification
PR template only; no contract or workflow behavior changes.
4. Commands Run
git diff --check— PASS (line-ending warnings only; no whitespace errors)5. CI Status
This PR is intentionally a draft until relevant hosted checks are visible and
green.
6. Acceptance Criteria Coverage
Contributor Self-Review
table instead of adding a duplicate.
dependencies, or workflow behavior changes.
updated consistently.
visible and green.
Known limitation: the Rust/contract suite was not run because the patch changes
Markdown and the PR template only.
Additional Context
This patch deliberately extends the completion table introduced by #136 rather
than creating a competing audit template.