Align repository structure with updated DEMA Consulting standards

[Copilot]

Pull Request

Description

Restructures docs/design, docs/reqstream, and .reviewmark.yaml to comply with updated DEMA Consulting standards for design documentation, requirements traceability, and file review tracking.

docs/design/

• Replaced introduction.txt with introduction.md containing required Software Structure and Folder Layout sections
• Added system.md with system architecture, interfaces, and data flow (OTS dependency descriptions reference package names only, without version numbers)
• Renamed nuget-cache-design.md → nuget-cache.md and path-helpers-design.md → path-helpers.md (removed -design suffix per standard)
• Updated definition.yaml (Pandoc defaults) to reference the renamed files and include system.md so documentation builds correctly

docs/reqstream/

• Added system.yaml for system-level requirements
• Renamed unit-nuget-cache.yaml → nuget-cache.yaml and unit-path-helpers.yaml → path-helpers.yaml (removed unit- prefix per standard)
• Moved all ots-*.yaml files into ots/ subfolder

requirements.yaml

• Updated all include paths to match new file locations

.reviewmark.yaml

• Added requirements.yaml to needs-review set
• Used glob pattern docs/design/**/*.md in NuGetCaching-Design review set instead of explicit file listing
• Removed standalone NuGetCaching-OTS and NuGetCaching-Platform review sets (both are fully covered by NuGetCaching-AllRequirements)

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
• 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:

• All linters pass: ./lint.sh (Unix/macOS) or cmd /c lint.bat / ./lint.bat (Windows)

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

Pure structural/naming alignment — no logic or behavior changes. All linters pass post-restructure.

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[Copilot]

Pull request overview

This PR restructures the repository’s design and requirements documentation (and associated review tracking) to align with updated DEMA Consulting standards for design docs, requirements traceability, and ReviewMark review-set organization.

Changes:

• Reorganized requirements under docs/reqstream/ (added system-level requirements, renamed unit requirement files, and moved OTS requirements into docs/reqstream/ots/).
• Reorganized design documentation under docs/design/ (migrated introduction to Markdown, added system design, and renamed unit design docs to drop -design suffix).
• Updated root requirements.yaml include paths and streamlined .reviewmark.yaml review-set definitions (including globbing for design docs).

Reviewed changes

Copilot reviewed 6 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
requirements.yaml	Updates ReqStream include paths to match the new requirements file layout.
docs/reqstream/system.yaml	Adds system-level requirements for the library.
docs/reqstream/nuget-cache.yaml	Adds/relocates NuGetCache unit requirements under the new naming scheme.
docs/reqstream/path-helpers.yaml	Adds/relocates PathHelpers unit requirements under the new naming scheme.
docs/reqstream/ots/buildmark.yaml	Relocates BuildMark OTS requirements into ots/ subfolder.
docs/reqstream/ots/mstest.yaml	Relocates MSTest OTS requirements into ots/ subfolder.
docs/reqstream/ots/nuget.yaml	Relocates NuGet client SDK OTS requirements into ots/ subfolder.
docs/reqstream/ots/reqstream.yaml	Relocates ReqStream OTS requirements into ots/ subfolder.
docs/reqstream/ots/reviewmark.yaml	Relocates ReviewMark OTS requirements into ots/ subfolder.
docs/reqstream/ots/sarifmark.yaml	Relocates SarifMark OTS requirements into ots/ subfolder.
docs/reqstream/ots/sonarmark.yaml	Relocates SonarMark OTS requirements into ots/ subfolder.
docs/reqstream/ots/versionmark.yaml	Relocates VersionMark OTS requirements into ots/ subfolder.
docs/design/introduction.txt	Removes the old text-based design introduction.
docs/design/introduction.md	Adds Markdown introduction with required “Software Structure” and “Folder Layout” sections.
docs/design/system.md	Adds system-level design documentation (architecture, interfaces, data flow).
docs/design/nuget-cache.md	Renames/updates NuGetCache unit design doc to the new standard filename.
docs/design/path-helpers.md	Renames/updates PathHelpers unit design doc to the new standard filename.
.reviewmark.yaml	Updates review scope patterns and review-sets to match the new file layout and standard grouping.

---

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

[Malcolmnixon]

@copilot Documentation build failed with pandoc.exe: docs/design/introduction.txt: withBinaryFile: does not exist (No such file or directory) please fix.

[Copilot]

@copilot Documentation build failed with pandoc.exe: docs/design/introduction.txt: withBinaryFile: does not exist (No such file or directory) please fix.

Fixed in 17e932d — updated docs/design/definition.yaml to reference the renamed files (introduction.md, system.md, nuget-cache.md, path-helpers.md).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)