diff --git a/.reviewmark.yaml b/.reviewmark.yaml index 196c965..7c243cd 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -31,15 +31,10 @@ reviews: - id: SarifMark-System title: Review of SarifMark System paths: - - "docs/reqstream/sarifmark-system.yaml" + - "docs/reqstream/system.yaml" - "docs/reqstream/platform-requirements.yaml" - - "docs/reqstream/ots-software.yaml" - "docs/design/introduction.md" - "docs/design/system.md" - - "docs/reqstream/unit-program.yaml" - - "docs/design/program.md" - - "src/**/Program.cs" - - "test/**/ProgramTests.cs" - "test/**/IntegrationTests.cs" - "test/**/Runner.cs" - "test/**/AssemblyInfo.cs" @@ -54,6 +49,17 @@ reviews: - "requirements.yaml" - "docs/reqstream/**/*.yaml" + # --------------------------------------------------------------------------- + # Design Review + # --------------------------------------------------------------------------- + + - id: SarifMark-Design + title: Review of SarifMark Design Documentation + paths: + - "docs/reqstream/system.yaml" + - "docs/reqstream/platform-requirements.yaml" + - "docs/design/**/*.md" + # --------------------------------------------------------------------------- # Subsystem Reviews # --------------------------------------------------------------------------- diff --git a/docs/design/system.md b/docs/design/system.md index 16c8286..8eb1f19 100644 --- a/docs/design/system.md +++ b/docs/design/system.md @@ -82,7 +82,7 @@ subsystem is a stateless helper used by `SelfTest` for path construction. ## System Requirements -System-level requirements are captured in `docs/reqstream/sarifmark-system.yaml` +System-level requirements are captured in `docs/reqstream/system.yaml` and are validated through integration tests that exercise the published dotnet DLL end-to-end across the supported platforms. diff --git a/docs/reqstream/ots-software.yaml b/docs/reqstream/ots/ots-software.yaml similarity index 100% rename from docs/reqstream/ots-software.yaml rename to docs/reqstream/ots/ots-software.yaml diff --git a/docs/reqstream/sarifmark-system.yaml b/docs/reqstream/system.yaml similarity index 100% rename from docs/reqstream/sarifmark-system.yaml rename to docs/reqstream/system.yaml diff --git a/requirements.yaml b/requirements.yaml index 2e25bbb..3855d11 100644 --- a/requirements.yaml +++ b/requirements.yaml @@ -13,7 +13,7 @@ # --- includes: - - docs/reqstream/sarifmark-system.yaml + - docs/reqstream/system.yaml - docs/reqstream/cli/subsystem-cli.yaml - docs/reqstream/cli/unit-context.yaml - docs/reqstream/sarif/subsystem-sarif.yaml @@ -25,5 +25,5 @@ includes: - docs/reqstream/utilities/subsystem-utilities.yaml - docs/reqstream/utilities/unit-path-helpers.yaml - docs/reqstream/platform-requirements.yaml - - docs/reqstream/ots-software.yaml + - docs/reqstream/ots/ots-software.yaml - docs/reqstream/unit-program.yaml