Skip to content

Move category files into correct locations and update references.#47

Merged
Malcolmnixon merged 2 commits into
mainfrom
category-markdowns
May 5, 2026
Merged

Move category files into correct locations and update references.#47
Malcolmnixon merged 2 commits into
mainfrom
category-markdowns

Conversation

@Malcolmnixon
Copy link
Copy Markdown
Member

Pull Request

Description

Move category files into correct locations and update references.

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

Closes #

Pre-Submission Checklist

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

Build and Test

  • Code builds successfully and all tests pass: pwsh ./build.ps1
  • Code produces zero warnings

Code Quality

  • 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: pwsh ./lint.ps1

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 docs/ documentation (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Copilot AI review requested due to automatic review settings May 5, 2026 22:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reorganizes the compliance/documentation artifact layout so system-level requirement, design, and verification files live at the collection root, with updated references across build inputs, review configuration, and documentation standards.

Changes:

  • Moves NuGetCaching system-level requirement, design, and verification documents to top-level docs/reqstream, docs/design, and docs/verification paths.
  • Adds an OTS verification section overview and adjusts heading depth throughout moved verification/design documents to match the new folder-depth rule.
  • Updates ReviewMark config, ReqStream/Pandoc definitions, and repository standards to reflect the new artifact layout.

Reviewed changes

Copilot reviewed 28 out of 31 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
requirements.yaml Updates root ReqStream include to new system requirements path.
docs/verification/ots/xunit.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/weasyprint.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/versionmark.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/sonarmark.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/sarifmark.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/reviewmark.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/reqstream.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/pandoc.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/fileassert.md Adjusts heading depth for OTS verification doc.
docs/verification/ots/buildmark.md Adjusts heading depth for OTS verification doc.
docs/verification/ots.md Adds top-level OTS verification overview section.
docs/verification/nuget-caching/path-helpers.md Adjusts heading depth for unit verification doc.
docs/verification/nuget-caching/nuget-cache.md Adjusts heading depth for unit verification doc.
docs/verification/nuget-caching.md Adds top-level system verification document.
docs/verification/introduction.md Updates artifact-path examples to new layout.
docs/verification/definition.yaml Updates verification build inputs for moved files and OTS overview.
docs/reqstream/nuget-caching.yaml Adds top-level system requirements file.
docs/design/nuget-caching/path-helpers.md Adjusts heading depth for unit design doc.
docs/design/nuget-caching/nuget-cache.md Adjusts heading depth for unit design doc.
docs/design/nuget-caching.md Adds top-level system design document.
docs/design/introduction.md Updates design tree to show new root system doc.
docs/design/definition.yaml Updates design build inputs for moved system doc.
AGENTS.md Normalizes punctuation in agent instructions.
.reviewmark.yaml Updates review-set paths to moved system docs/requirements.
.github/standards/verification-documentation.md Revises verification structure standard for parent-folder overview files and OTS overview.
.github/standards/technical-documentation.md Adds mandatory heading-depth rule.
.github/standards/software-items.md Documents OTS artifact locations and optional OTS test project pattern.
.github/standards/reviewmark-usage.md Updates ReviewMark path patterns and adds OTS review guidance.
.github/standards/reqstream-usage.md Updates ReqStream folder-layout guidance to new root system-file pattern.
.github/standards/design-documentation.md Revises design structure standard for parent-folder overview files and heading depth.
Comments suppressed due to low confidence (1)

docs/verification/definition.yaml:18

  • requirements.yaml still includes docs/reqstream/ots/nuget.yaml, but the verification bundle here does not include a matching docs/verification/ots/nuget.md (and there is no such file in the repository). That leaves the NuGet.Protocol / NuGet.Configuration OTS requirements without any verification evidence in the compiled verification document.
  - docs/verification/ots.md
  - docs/verification/ots/buildmark.md
  - docs/verification/ots/fileassert.md
  - docs/verification/ots/pandoc.md
  - docs/verification/ots/reqstream.md

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

Comment thread docs/verification/ots.md
@Malcolmnixon
Copy link
Copy Markdown
Member Author

@copilot apply changes based on the comments in this thread

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.

3 participants