Skip to content

Move category files into correct locations and update references.#44

Merged
Malcolmnixon merged 1 commit intomainfrom
category-markdowns
May 5, 2026
Merged

Move category files into correct locations and update references.#44
Malcolmnixon merged 1 commit intomainfrom
category-markdowns

Conversation

@Malcolmnixon
Copy link
Copy Markdown
Member

Pull Request

Description

Move category files into correct locations and update references.

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

Closes #

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully and all tests pass: pwsh ./build.ps1
  • Code produces zero warnings

Code Quality

  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • All linters pass: pwsh ./lint.ps1

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 docs/ documentation (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Copilot AI review requested due to automatic review settings May 5, 2026 19: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 reorganizes requirements, design, and verification documentation so that “overview/category” files live in their parent folders (rather than inside their own subfolders), and updates all includes/references to match. This aligns the docs tree structure with the documented “heading depth = folder depth” rule used for Pandoc compilation.

Changes:

  • Moved FileAssert system/subsystem requirement YAML entrypoints to new paths (e.g., docs/reqstream/file-assert.yaml, docs/reqstream/file-assert/cli.yaml) and updated requirements.yaml + ReviewMark paths accordingly.
  • Reworked design/verification markdown heading levels across many files to satisfy the Heading Depth Rule and updated Pandoc definition.yaml inputs to the new locations.
  • Added top-level overview docs for OTS verification (docs/verification/ots.md) and system-level design/verification (docs/design/file-assert.md, docs/verification/file-assert.md), plus updated standards docs to describe the new structure.

Reviewed changes

Copilot reviewed 65 out of 73 changed files in this pull request and generated no comments.

Show a summary per file
File Description
requirements.yaml Updates ReqStream includes to new system/subsystem requirement file locations.
docs/verification/ots/xunit.md Adjusts heading depths to match docs/verification/ots/ folder depth.
docs/verification/ots/weasyprint.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/versionmark.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/sonarmark.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/sarifmark.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/reviewmark.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/reqstream.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/pandoc.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/fileassert.md Adjusts heading depths for OTS verification structure.
docs/verification/ots/buildmark.md Adjusts heading depths for OTS verification structure.
docs/verification/ots.md Adds an OTS overview section so OTS docs compile as a top-level PDF section.
docs/verification/introduction.md Updates “companion artifact” path examples to new structure.
docs/verification/file-assert/utilities/path-helpers.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/utilities.md Adjusts heading depths for subsystem verification overview at depth 1.
docs/verification/file-assert/selftest/validation.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/selftest.md Adjusts heading depths for subsystem verification overview at depth 1.
docs/verification/file-assert/program.md Adjusts heading depths for unit verification file at depth 1.
docs/verification/file-assert/modeling/file-assert-yaml-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-xml-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-text-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-test.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-rule.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-pdf-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-json-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-html-assert.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling/file-assert-file.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/modeling.md Adjusts heading depths for subsystem verification overview at depth 1.
docs/verification/file-assert/configuration/file-assert-data.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/configuration/file-assert-config.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/configuration.md Adjusts heading depths for subsystem verification overview at depth 1.
docs/verification/file-assert/cli/context.md Adjusts heading depths for unit verification file at depth 2.
docs/verification/file-assert/cli.md Adjusts heading depths for subsystem verification overview at depth 1.
docs/verification/file-assert.md Adds system-level verification overview at docs/verification/ root.
docs/verification/definition.yaml Updates Pandoc input ordering and paths to match the new doc locations.
docs/reqstream/file-assert/utilities.yaml Adds subsystem requirements entrypoint file at new location.
docs/reqstream/file-assert/selftest.yaml Adds subsystem requirements entrypoint file at new location.
docs/reqstream/file-assert/modeling.yaml Adds subsystem requirements entrypoint file at new location.
docs/reqstream/file-assert/configuration.yaml Adds subsystem requirements entrypoint file at new location.
docs/reqstream/file-assert/cli.yaml Adds subsystem requirements entrypoint file at new location.
docs/reqstream/file-assert.yaml Adds system requirements entrypoint file at new location.
docs/design/introduction.md Documents the companion artifact structure matching the new paths.
docs/design/file-assert/utilities/path-helpers.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/utilities.md Adjusts heading depths for subsystem design overview at depth 1.
docs/design/file-assert/selftest/validation.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/selftest.md Adjusts heading depths for subsystem design overview at depth 1.
docs/design/file-assert/program.md Adjusts heading depths for unit design file at depth 1.
docs/design/file-assert/ots-dependencies.md Adjusts heading depths for OTS dependency design section.
docs/design/file-assert/modeling/file-assert-yaml-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-xml-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-text-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-test.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-rule.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-pdf-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-json-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-html-assert.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling/file-assert-file.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/modeling.md Adjusts heading depths for subsystem design overview at depth 1.
docs/design/file-assert/configuration/file-assert-data.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/configuration/file-assert-config.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/configuration.md Adjusts heading depths for subsystem design overview at depth 1.
docs/design/file-assert/cli/context.md Adjusts heading depths for unit design file at depth 2.
docs/design/file-assert/cli.md Adjusts heading depths for subsystem design overview at depth 1.
docs/design/file-assert.md Adds system-level design overview at docs/design/ root.
docs/design/definition.yaml Updates Pandoc input ordering and paths to match the new doc locations.
AGENTS.md Minor punctuation normalization in guidance text.
.reviewmark.yaml Updates review-set file paths to match moved requirement/design/verification entrypoints.
.github/standards/verification-documentation.md Updates the documented verification tree structure and adds mandatory ots.md guidance.
.github/standards/technical-documentation.md Adds the Heading Depth Rule used by the documentation compilation process.
.github/standards/software-items.md Clarifies OTS artifact locations and where OTS tests should live if needed.
.github/standards/reviewmark-usage.md Updates documented ReviewMark path patterns for the new doc/req layout and adds OTS review-set guidance.
.github/standards/reqstream-usage.md Updates documented ReqStream folder structure patterns to match the new layout.
.github/standards/design-documentation.md Updates the documented design tree structure and explicitly ties it to the Heading Depth Rule.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Malcolmnixon Malcolmnixon merged commit 104c1b5 into main May 5, 2026
19 checks passed
@Malcolmnixon Malcolmnixon deleted the category-markdowns branch May 5, 2026 20:30
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.

2 participants