Skip to content

Commit da2911b

Browse files
Address review feedback: fix verification docs and design intro references
Agent-Logs-Url: https://github.com/demaconsulting/ReqStream/sessions/2e852b28-749e-4d58-aa87-34636cd8d3c6 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 8d3aeab commit da2911b

5 files changed

Lines changed: 9 additions & 5 deletions

File tree

docs/design/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,5 +147,5 @@ For example, the `Requirements` unit maps to:
147147

148148
## References
149149

150-
- [ReqStream System Requirements](../reqstream/reqstream.yaml)
151-
- [ReqStream Requirements Root](../../requirements.yaml)
150+
- ReqStream System Requirements document
151+
- ReqStream Requirements Root document

docs/verification/definition.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ input-files:
3737
- docs/verification/ots/sonarmark.md
3838
- docs/verification/ots/versionmark.md
3939
- docs/verification/ots/weasyprint.md
40+
- docs/verification/ots/yamldotnet.md
41+
- docs/verification/ots/testresults.md
4042
template: template.html
4143
table-of-contents: true
4244
number-sections: true

docs/verification/introduction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This document covers verification of the following software units:
3232
- **SelfTest** subsystem:
3333
- **Validation** unit — self-validation test runner (`SelfTest/Validation.cs`)
3434

35-
The following nine OTS items are also verified:
35+
The following eleven OTS items are also verified:
3636

3737
- **BuildMark** — build-notes documentation generator
3838
- **FileAssert** — document assertion tool
@@ -43,6 +43,8 @@ The following nine OTS items are also verified:
4343
- **SonarMark** — SonarCloud quality reporter
4444
- **VersionMark** — version tracking tool
4545
- **WeasyPrint** — HTML to PDF converter
46+
- **YamlDotNet** — YAML parsing library
47+
- **DemaConsulting.TestResults** — test result file reader
4648

4749
The following topics are out of scope:
4850

docs/verification/ots/pandoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation build pipeline.
1111
Pandoc is verified by CI pipeline step evidence combined with FileAssert document validation.
1212
Each Markdown document collection (build notes, code quality report, review plan, review
1313
report, design document, user guide, requirements document, requirements report, and
14-
verification document) is converted to HTML by Pandoc in the CI pipeline.FileAssert then asserts that each generated
14+
verification document) is converted to HTML by Pandoc in the CI pipeline. FileAssert then asserts that each generated
1515
HTML file exists, has a non-trivial size, contains a valid HTML title element, and includes
1616
expected document content. Passing FileAssert assertions confirm Pandoc executed correctly
1717
and produced meaningful output.

docs/verification/ots/weasyprint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation build pipeline.
1111
WeasyPrint is verified by CI pipeline step evidence combined with FileAssert document
1212
validation. Each HTML document (build notes, code quality report, review plan, review report,
1313
design document, user guide, requirements document, requirements report, and verification
14-
document) is converted to PDF by WeasyPrint in the CI pipeline.FileAssert then asserts that each generated
14+
document) is converted to PDF by WeasyPrint in the CI pipeline. FileAssert then asserts that each generated
1515
PDF file exists, has a non-trivial size, contains at least one page, and includes expected
1616
document content in the rendered text. Passing FileAssert assertions confirm WeasyPrint
1717
executed correctly and produced meaningful output.

0 commit comments

Comments
 (0)