Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: reorganize design and reqstream into system-name subfolders per…
… 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>
  • Loading branch information
Copilot and Malcolmnixon authored Apr 3, 2026
commit f9db0d0456052965a56ac44bb87d26c4427f356c
20 changes: 10 additions & 10 deletions .reviewmark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ evidence-source:
location: https://raw.githubusercontent.com/demaconsulting/NuGetCaching/reviews/index.json

reviews:
- id: NuGetCaching-System
title: Review of NuGetCaching System Integration
- id: NuGetCaching-Architecture
title: Review of NuGetCaching System Architecture
paths:
- "docs/reqstream/system.yaml"
- "docs/reqstream/nuget-caching/nuget-caching.yaml"
- "docs/design/introduction.md"
- "docs/design/system.md"
- "docs/design/nuget-caching/nuget-caching.md"

- id: NuGetCaching-Design
title: Review of NuGetCaching Architecture and Design
paths:
- "docs/reqstream/system.yaml"
- "docs/reqstream/platform-requirements.yaml"
- "docs/reqstream/nuget-caching/nuget-caching.yaml"
- "docs/reqstream/nuget-caching/platform-requirements.yaml"
- "docs/design/**/*.md"

- id: NuGetCaching-AllRequirements
Expand All @@ -36,15 +36,15 @@ reviews:
- id: NuGetCaching-NuGetCache
title: Review of NuGetCaching NuGetCache Unit
paths:
- "docs/reqstream/nuget-cache.yaml"
- "docs/design/nuget-cache.md"
- "docs/reqstream/nuget-caching/nuget-cache.yaml"
- "docs/design/nuget-caching/nuget-cache.md"
- "src/**/NuGetCache.cs"
- "test/**/NuGetCacheTests.cs"

- id: NuGetCaching-PathHelpers
title: Review of NuGetCaching PathHelpers Unit
paths:
- "docs/reqstream/path-helpers.yaml"
- "docs/design/path-helpers.md"
- "docs/reqstream/nuget-caching/path-helpers.yaml"
- "docs/design/nuget-caching/path-helpers.md"
- "src/**/PathHelpers.cs"
- "test/**/PathHelpersTests.cs"
6 changes: 3 additions & 3 deletions docs/design/definition.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ resource-path:
input-files:
- docs/design/title.txt
- docs/design/introduction.md
- docs/design/system.md
- docs/design/nuget-cache.md
- docs/design/path-helpers.md
- docs/design/nuget-caching/nuget-caching.md
- docs/design/nuget-caching/nuget-cache.md
- docs/design/nuget-caching/path-helpers.md
template: template.html
table-of-contents: true
number-sections: true
11 changes: 11 additions & 0 deletions docs/design/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ src/DemaConsulting.NuGet.Caching/
└── PathHelpers.cs — Safe path combination utilities (internal)
```

Design documentation mirrors the software structure:

```text
docs/design/
├── introduction.md — Design overview and software structure
└── nuget-caching/
├── nuget-caching.md — System-level design
├── nuget-cache.md — NuGetCache unit design
└── path-helpers.md — PathHelpers unit design
```

Test code mirrors the source structure:

```text
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions requirements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
# list below (unit files first, then platform, then ots in alphabetical order)
Comment thread
Malcolmnixon marked this conversation as resolved.
Outdated

includes:
- docs/reqstream/system.yaml
- docs/reqstream/nuget-cache.yaml
- docs/reqstream/path-helpers.yaml
- docs/reqstream/platform-requirements.yaml
- docs/reqstream/nuget-caching/nuget-caching.yaml
- docs/reqstream/nuget-caching/nuget-cache.yaml
- docs/reqstream/nuget-caching/path-helpers.yaml
- docs/reqstream/nuget-caching/platform-requirements.yaml
- docs/reqstream/ots/buildmark.yaml
- docs/reqstream/ots/mstest.yaml
- docs/reqstream/ots/nuget.yaml
Expand Down