docs: reorganize design and reqstream into system-name subfolders; sync template files#25
Merged
Malcolmnixon merged 3 commits intomainfrom Apr 3, 2026
Merged
Conversation
…TemplateDotNetLibrary Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/92ec5108-3318-442f-b298-d5d31386709f Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
… updated standards Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/ba1d0f14-2e46-4863-b2fc-bbaf9a23790a Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
Malcolmnixon
April 3, 2026 13:49
View session
Malcolmnixon
approved these changes
Apr 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs updated Continuous Compliance template files and restructures design/requirements documentation to follow the updated {system-name}/ subfolder hierarchy (for the nuget-caching system), with corresponding updates to ReviewMark config and lint scripts.
Changes:
- Reorganized
docs/design/anddocs/reqstream/intodocs/*/nuget-caching/and updated Pandoc/ReqStream entry points accordingly. - Updated
.reviewmark.yamlreview-set IDs and paths to match the new documentation layout. - Synced template agent/standards content and refined
lint.sh/lint.batexecution flow.
Reviewed changes
Copilot reviewed 14 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| requirements.yaml | Updates ReqStream includes to point at the new docs/reqstream/nuget-caching/ paths. |
| lint.sh | Refactors lint flow into Python/NPM/.NET sections with skip-on-failure flags. |
| lint.bat | Mirrors the lint flow refactor for Windows with section labels and error handling. |
| docs/reqstream/nuget-caching/nuget-caching.yaml | Adds system-level requirements under the new system folder. |
| docs/reqstream/nuget-caching/nuget-cache.yaml | Adds unit requirements for NuGetCache under the new system folder. |
| docs/reqstream/nuget-caching/path-helpers.yaml | Adds unit requirements for PathHelpers under the new system folder. |
| docs/reqstream/nuget-caching/platform-requirements.yaml | Adds platform/runtime requirements under the new system folder. |
| docs/design/introduction.md | Updates design intro to document the new docs/design/{system}/ layout. |
| docs/design/definition.yaml | Updates Pandoc input file paths to the new system subfolder. |
| docs/design/nuget-caching/nuget-caching.md | Adds system-level design doc in the new system folder. |
| docs/design/nuget-caching/nuget-cache.md | Adds NuGetCache unit design doc in the new system folder. |
| docs/design/nuget-caching/path-helpers.md | Adds PathHelpers unit design doc in the new system folder. |
| AGENTS.md | Syncs/expands agent guidance and project structure references from the template. |
| .reviewmark.yaml | Renames the system review-set and updates file paths for the new doc structure. |
| .github/standards/technical-documentation.md | Updates documented repo folder layout to the {system-name}/ hierarchy. |
| .github/standards/reviewmark-usage.md | Updates ReviewMark usage guidance and path conventions for the new structure. |
| .github/standards/reqstream-usage.md | Updates ReqStream folder conventions and examples for the new structure. |
| .github/standards/design-documentation.md | Updates design documentation folder conventions to include {system-name}/. |
| .github/agents/quality.agent.md | Adds explicit Result semantics and software item completeness checks. |
| .github/agents/implementation.agent.md | Tweaks orchestrator context handoff wording and formatting. |
| .github/agents/developer.agent.md | Adds lint-fix process guidance before quality gates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…(system, platform, unit, ots) Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/54aa4b05-e1cb-4c37-9485-52bb2f549a0b Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Malcolmnixon
approved these changes
Apr 3, 2026
Malcolmnixon
approved these changes
Apr 3, 2026
This was referenced Apr 3, 2026
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.
Syncs updated agent/standards files from
TemplateDotNetLibraryand restructuresdocs/design/anddocs/reqstream/to comply with the updated standards requiring a{system-name}/subfolder hierarchy.Description
Template sync — binary-copy of updated files from
demaconsulting/TemplateDotNetLibrary:AGENTS.md.github/agents/*.md(5 agent definitions).github/standards/*.md(7 standards files)lint.sh/lint.batDesign documentation restructure — per
design-documentation.md:docs/design/{system,nuget-cache,path-helpers}.mdintodocs/design/nuget-caching/system.md→nuget-caching/nuget-caching.md(system doc named after system)introduction.mdFolder Layout section to show the new subfolder treedefinition.yamlPandoc input pathsRequirements restructure — per
reqstream-usage.md:docs/reqstream/{system,nuget-cache,path-helpers,platform-requirements}.yamlintodocs/reqstream/nuget-caching/system.yaml→nuget-caching/nuget-caching.yamlrequirements.yamlincludes to follow the standard ordering: system → platform → subsystem/unit → otsrequirements.yamlheader comment to describe the correct ordering conventionReviewMark — per
reviewmark-usage.md:NuGetCaching-System→NuGetCaching-Architecture(standard[System]-Architecturepattern)Type of Change
Related Issues
Pre-Submission Checklist
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes
No source code changes. All CI pipeline paths (
artifacts/**/*.trx, build scripts) are unaffected — only documentation folder structure and review configuration updated.