Skip to content

Rename ARCHITECTURE.md to THEORY-OF-OPERATIONS.md#6

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/rename-architecture-document
Mar 9, 2026
Merged

Rename ARCHITECTURE.md to THEORY-OF-OPERATIONS.md#6
Malcolmnixon merged 4 commits intomainfrom
copilot/rename-architecture-document

Conversation

Copy link
Contributor

Copilot AI commented Mar 9, 2026

ARCHITECTURE.md is a theory-of-operations document, not an architecture document. Renaming it to THEORY-OF-OPERATIONS.md for accuracy, and updating all references across the repo.

Description

Renames ARCHITECTURE.mdTHEORY-OF-OPERATIONS.md and updates all callsites:

  • README.md — updated link text, reference URL, description (changed "full design" to "theory of operations"), and renamed the link reference key from link-architecture to link-theory-of-operations to match the target document
  • GlobMatcher.cs — updated inline comment referencing the document
  • .github/pull_request_template.md — PR checklist retains ARCHITECTURE.md as a placeholder for the future architecture document

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

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

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0
    --no-build -- --validate
  • 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

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

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 functional changes — this is a pure rename with reference updates.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Rename ARCHITECTURE.md to theory-of-operations Rename ARCHITECTURE.md to THEORY-OF-OPERATIONS.md Mar 9, 2026
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 9, 2026 14:37
Copilot AI review requested due to automatic review settings March 9, 2026 14:37
Copy link
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

Renames the repository’s theory-of-operations documentation from ARCHITECTURE.md to THEORY-OF-OPERATIONS.md, and updates in-repo references to match the new name.

Changes:

  • Added THEORY-OF-OPERATIONS.md as the primary theory-of-operations document (replacing the old ARCHITECTURE.md naming).
  • Updated README documentation link and URL to point to THEORY-OF-OPERATIONS.md.
  • Updated an inline code comment in GlobMatcher.cs to reference the renamed document.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/DemaConsulting.ReviewMark/GlobMatcher.cs Updates inline documentation reference from the old doc name to the new one.
THEORY-OF-OPERATIONS.md Adds the renamed/reframed theory-of-operations document content.
README.md Updates the public-facing documentation link text and target to the renamed doc.

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

You can also share your feedback on Copilot code review. Take the survey.

…erations in README.md

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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