Skip to content

docs: reorganize design and reqstream into system-name subfolders; sync template files#25

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/copy-updated-template-files
Apr 3, 2026
Merged

docs: reorganize design and reqstream into system-name subfolders; sync template files#25
Malcolmnixon merged 3 commits intomainfrom
copilot/copy-updated-template-files

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

Syncs updated agent/standards files from TemplateDotNetLibrary and restructures docs/design/ and docs/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.bat

Design documentation restructure — per design-documentation.md:

  • Moved flat docs/design/{system,nuget-cache,path-helpers}.md into docs/design/nuget-caching/
  • Renamed system.mdnuget-caching/nuget-caching.md (system doc named after system)
  • Updated introduction.md Folder Layout section to show the new subfolder tree
  • Updated definition.yaml Pandoc input paths

Requirements restructure — per reqstream-usage.md:

  • Moved flat docs/reqstream/{system,nuget-cache,path-helpers,platform-requirements}.yaml into docs/reqstream/nuget-caching/
  • Renamed system.yamlnuget-caching/nuget-caching.yaml
  • Updated requirements.yaml includes to follow the standard ordering: system → platform → subsystem/unit → ots
  • Updated requirements.yaml header comment to describe the correct ordering convention

ReviewMark — per reviewmark-usage.md:

  • Renamed review set NuGetCaching-SystemNuGetCaching-Architecture (standard [System]-Architecture pattern)
  • Updated all file paths across all five review sets

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

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

  • 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

No source code changes. All CI pipeline paths (artifacts/**/*.trx, build scripts) are unaffected — only documentation folder structure and review configuration updated.

Copilot AI and others added 2 commits April 3, 2026 13:40
…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>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 3, 2026 13:50
Copilot AI review requested due to automatic review settings April 3, 2026 13:50
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

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/ and docs/reqstream/ into docs/*/nuget-caching/ and updated Pandoc/ReqStream entry points accordingly.
  • Updated .reviewmark.yaml review-set IDs and paths to match the new documentation layout.
  • Synced template agent/standards content and refined lint.sh/lint.bat execution 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 Malcolmnixon merged commit 4c99893 into main Apr 3, 2026
6 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/copy-updated-template-files branch April 3, 2026 14:26
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