Sync with TemplateDotNetTool template PRs (#58, #65, #66, #67, #70, #75)

[Copilot]

Pull Request

Description

Applies accumulated template repo changes from demaconsulting/TemplateDotNetTool. Covers doc folder renames, ReviewMark self-review integration, updated agent files, and CI/CD workflow alignment.

Documentation Structure

• Renamed docs folders to canonical names: buildnotes/ → build_notes/, quality/ → code_quality/, requirements/ → requirements_doc/, tracematrix/ → requirements_report/
• Removed justifications/ folder (content folded into requirements_doc/)
• Added code_review_plan/ and code_review_report/ docs folders with definition files

ReviewMark Self-Review Integration (PR #58)

• Added .reviewmark.yaml following the file-reviews.md guidance:
  • needs-review tracks docs/reqstream/*.yaml (the per-software-item requirements files)
  • Each review-set includes its specific focused requirements file, giving AI reviewers the full evidence chain (requirements → source → tests)
  • docs/guide/guide.md included in the ReviewMark-Program review-set
  • Descriptive review-set titles indicating each unit's functional purpose
• Split requirements.yaml into focused per-software-item files under docs/reqstream/ following requirements.md guidance:
  • docs/reqstream/cli-requirements.yaml — all ReviewMark-Cmd-* requirements (CLI subsystem)
  • docs/reqstream/configuration-requirements.yaml — ReviewMark-Config-Reading (ReviewMarkConfiguration unit)
  • docs/reqstream/index-requirements.yaml — evidence source and PDF parsing requirements (Index unit)
  • docs/reqstream/platform-requirements.yaml — cross-platform support requirements
  • docs/reqstream/ots-requirements.yaml — OTS software requirements
• requirements.yaml is now a thin root file using includes that lists the five sub-files

CI/CD Workflows (PRs #65, #75)

• Updated build.yaml: doc path references, ReviewMark plan/report generation steps, artifact handling
  • Fixed "Generate Review Plan and Review Report with ReviewMark" step in the build-docs job to invoke reviewmark (the globally installed tool) instead of dotnet run --project src/DemaConsulting.ReviewMark ...
• Updated release.yaml: uses artifacts/build_notes.md directly (removes the "Move buildnotes.md to root" step)

Agent Files (PRs #66, #67, #70)

• Replaced requirements, software-developer, technical-writer, and test-developer agent files with comprehensive template versions
• Updated AGENTS.md with expanded quality gate enforcement and @agent invocation format

Supporting Files

• .gitignore: updated generated-doc exclusion paths
• .cspell.yaml: replaced old folder-name terms with new canonical names

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

• Code builds successfully: dotnet build --configuration Release
• All unit tests pass: dotnet test --configuration Release
• Self-validation tests pass:
  dotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0
--no-build -- --validate
• Code produces zero warnings

Code Quality

• Code formatting is correct: dotnet format --verify-no-changes
• New code has appropriate XML documentation comments
• Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

• Spell checker passes: cspell "**/*.{md,cs}"
• Markdown linter passes: markdownlint "**/*.md"
• YAML linter passes: yamllint .

Testing

• Added unit tests for new functionality
• Updated existing tests if behavior changed
• All tests follow the AAA (Arrange, Act, Assert) pattern
• Test coverage is maintained or improved

Documentation

• Updated README.md (if applicable)
• Updated ARCHITECTURE.md (if applicable)
• Added code examples for new features (if applicable)
• Updated requirements.yaml (if applicable)

Additional Notes

Changes applied by the repo-consistency agent based on the 20 most recent merged PRs in demaconsulting/TemplateDotNetTool. No source code or test logic was modified; all changes are tooling, CI/CD, docs structure, and agent configuration.

---

⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.

[Malcolmnixon]

@copilot please make sure the review-sets in .reviewmark.yaml are appropriate. Read https://raw.githubusercontent.com/demaconsulting/ContinuousCompliance/refs/heads/main/docs/file-reviews.md to understand good review-set patterns.

[Copilot]

@copilot please make sure the review-sets in .reviewmark.yaml are appropriate. Read https://raw.githubusercontent.com/demaconsulting/ContinuousCompliance/refs/heads/main/docs/file-re...

Updated the review-sets in commit 661da36 based on the file-reviews.md guidance.

Key changes made:

• Added requirements.yaml to needs-review so the requirements document itself is tracked for review coverage
• Included requirements.yaml in every review-set's paths, giving AI reviewers the full evidence chain (requirements + source + tests) to verify consistency
• Added docs/guide/guide.md to the ReviewMark-Program review-set (the user guide describes CLI behavior and belongs alongside the Program unit)
• Improved review-set titles to be more descriptive (e.g. "Review of Context software unit (command-line argument handling)")

[Malcolmnixon]

@copilot The requirements.yaml file needs to be split into separate files (one for each software item) as defined by https://raw.githubusercontent.com/demaconsulting/ContinuousCompliance/refs/heads/main/docs/requirements.md then the review-sets adjusted.

[Copilot]

@copilot The requirements.yaml file needs to be split into separate files (one for each software item) as defined by https://raw.githubusercontent.com/demaconsulting/ContinuousCompliance/refs/heads/ma...

Done in commit 3ae2706. The requirements have been split into 5 focused files under docs/reqstream/:

• cli-requirements.yaml — all 20 ReviewMark-Cmd-* requirements (CLI subsystem spanning Context.cs + Program.cs)
• configuration-requirements.yaml — ReviewMark-Config-Reading (ReviewMarkConfiguration unit)
• index-requirements.yaml — ReviewMark-Index-EvidenceSource, ReviewMark-EvidenceSource-None, ReviewMark-Index-PdfParsing (Index unit)
• platform-requirements.yaml — ReviewMark-Platform-* requirements (Windows, Linux, macOS, .NET 8/9/10)
• ots-requirements.yaml — ReviewMark-OTS-* requirements (MSTest, ReqStream, BuildMark, VersionMark, SarifMark, SonarMark)

requirements.yaml is now a thin root file using includes that lists all 5 sub-files. The .reviewmark.yaml needs-review patterns now track docs/reqstream/*.yaml instead of the root file, and each review-set references its specific requirements file (e.g. ReviewMark-Index → index-requirements.yaml, ReviewMark-Configuration → configuration-requirements.yaml). GlobMatcher and PathHelpers have no dedicated requirements file as they are internal utilities.

[Copilot]

Pull request overview

Syncs this repository with upstream TemplateDotNetTool conventions by reorganizing compliance documentation, adopting ReviewMark self-review configuration, and aligning CI/CD workflows and agent guidance with the template.

Changes:

• Replaced the monolithic requirements.yaml with a thin root file that includes focused requirement files under docs/reqstream/.
• Renamed/restructured compliance docs folders and added new Pandoc document structures (requirements doc/report, code quality, build notes, review plan/report).
• Updated CI workflows to use new doc paths and to generate ReviewMark plan/report output; refreshed agent guidance and spelling dictionary entries.

Reviewed changes

Copilot reviewed 32 out of 41 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
requirements.yaml	Converts to a root ReqStream entrypoint that includes focused requirement files.
docs/tracematrix/definition.yaml	Removes old trace matrix Pandoc definition (folder renamed/replaced).
docs/requirements_report/title.txt	Adds Pandoc metadata for the requirements trace matrix document.
docs/requirements_report/introduction.md	Adds trace matrix introduction content.
docs/requirements_report/definition.yaml	Adds Pandoc definition for the trace matrix document.
docs/requirements_doc/title.txt	Adds Pandoc metadata for the requirements document.
docs/requirements_doc/introduction.md	Adds requirements document introduction content.
docs/requirements_doc/definition.yaml	Adds Pandoc definition for requirements + justifications doc compilation.
docs/requirements/definition.yaml	Removes old requirements Pandoc definition (folder renamed/replaced).
docs/reqstream/platform-requirements.yaml	Adds platform/runtime requirements in a focused file.
docs/reqstream/ots-requirements.yaml	Adds OTS requirements in a focused file.
docs/reqstream/index-requirements.yaml	Adds Index unit requirements in a focused file.
docs/reqstream/configuration-requirements.yaml	Adds configuration unit requirements in a focused file.
docs/reqstream/cli-requirements.yaml	Adds CLI subsystem requirements in a focused file.
docs/quality/definition.yaml	Removes old quality Pandoc definition (folder renamed/replaced).
docs/justifications/title.txt	Removes old justifications title (folded into requirements_doc output).
docs/justifications/introduction.md	Removes old justifications intro (folded into requirements_doc output).
docs/justifications/definition.yaml	Removes old justifications Pandoc definition (folder renamed/replaced).
docs/code_review_report/title.txt	Adds Pandoc metadata for ReviewMark review report.
docs/code_review_report/introduction.md	Adds review report introduction content.
docs/code_review_report/definition.yaml	Adds Pandoc definition for review report document.
docs/code_review_plan/title.txt	Adds Pandoc metadata for ReviewMark review plan.
docs/code_review_plan/introduction.md	Adds review plan introduction content.
docs/code_review_plan/definition.yaml	Adds Pandoc definition for review plan document.
docs/code_quality/title.txt	Adds Pandoc metadata for code quality document.
docs/code_quality/introduction.md	Adds code quality document introduction content.
docs/code_quality/definition.yaml	Adds Pandoc definition for code quality document.
docs/buildnotes/definition.yaml	Removes old buildnotes Pandoc definition (folder renamed/replaced).
docs/build_notes/title.txt	Adds Pandoc metadata for build notes document.
docs/build_notes/introduction.md	Adds build notes introduction content.
docs/build_notes/definition.yaml	Adds Pandoc definition for build notes document structure.
AGENTS.md	Updates agent naming/invocation format and expands quality gate guidance.
.reviewmark.yaml	Introduces ReviewMark self-review configuration (needs-review + review-sets + evidence source).
.gitignore	Updates generated-doc ignore paths to match renamed doc folders.
.github/workflows/release.yaml	Updates release body file reference to new build notes name/path.
.github/workflows/build.yaml	Updates doc generation paths and adds ReviewMark plan/report generation + conversion steps.
.github/agents/test-developer.agent.md	Replaces test developer agent guidance with template version.
.github/agents/technical-writer.agent.md	Replaces technical writer agent guidance with template version.
.github/agents/software-developer.agent.md	Replaces software developer agent guidance with template version.
.github/agents/requirements.agent.md	Replaces requirements agent guidance with template version.
.cspell.yaml	Updates allowed terms for renamed folders and new generated-doc names.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Malcolmnixon]

@copilot In the build-docs job of build.yaml the "Generate Review Plan and Review Report with ReviewMark" step should run the reviewmark global tool installed previously in the "Install ReviewMark from package" by just running "reviewmark".

[Copilot]

@copilot In the build-docs job of build.yaml the "Generate Review Plan and Review Report with ReviewMark" step should run the reviewmark global tool installed previously in the "Install ReviewMark fro...

Fixed in commit b04c38a. The step now calls reviewmark directly instead of dotnet run --project src/DemaConsulting.ReviewMark ....