Move category files into correct locations and update references.#47
Merged
Conversation
Contributor
There was a problem hiding this comment.
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, anddocs/verificationpaths. - 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.yamlstill includesdocs/reqstream/ots/nuget.yaml, but the verification bundle here does not include a matchingdocs/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.
Member
Author
|
@copilot apply changes based on the comments in this thread |
Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/1506c0ac-d927-4664-8090-256b22a5f0f4 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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.
Pull Request
Description
Move category files into correct locations and update references.
Type of Change
Related Issues
Closes #
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
pwsh ./build.ps1Code Quality
Quality Checks
Please run the following checks before submitting:
pwsh ./lint.ps1Testing
Documentation
Additional Notes