docs: update invariant references in documentation for accuracy#10
Merged
docs: update invariant references in documentation for accuracy#10
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates invariant identifiers across the codebase (docs, XML docs, and test names) to a new structured numbering scheme (e.g., B.11 → B.1, H.49 → H.3) to improve consistency and traceability between architecture specs and implementation/tests.
Changes:
- Renumber invariant references throughout
docs/*.mdand component documentation to the new scheme. - Rename invariant test methods/data providers to match the updated identifiers.
- Update XML documentation comments in public/internal C# types to reference the new invariant IDs.
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/SlidingWindowCache.Unit.Tests/Infrastructure/Storage/TestInfrastructure/CacheStorageTestsBase.cs | Renames invariant section/methods and references from B.11 to B.1. |
| tests/SlidingWindowCache.Unit.Tests/Infrastructure/Storage/SnapshotReadStorageTests.cs | Updates summary invariant reference to B.1. |
| tests/SlidingWindowCache.Unit.Tests/Infrastructure/Storage/CopyOnReadStorageTests.cs | Updates summary invariant reference to B.1. |
| tests/SlidingWindowCache.Tests.Infrastructure/Helpers/TestHelpers.cs | Updates doc comment invariant reference from D.28 to D.4. |
| tests/SlidingWindowCache.Invariants.Tests/WindowCacheInvariantTests.cs | Renames tests/data providers and updates invariant references to the new scheme across the suite. |
| tests/SlidingWindowCache.Invariants.Tests/README.md | Updates test suite documentation and filter examples to new invariant IDs. |
| src/SlidingWindowCache/Public/Instrumentation/ICacheDiagnostics.cs | Updates XML doc invariant references for diagnostics counters. |
| src/SlidingWindowCache/Public/Extensions/WindowCacheConsistencyExtensions.cs | Updates H.49 references to H.3 in XML docs. |
| src/SlidingWindowCache/Infrastructure/Storage/CopyOnReadStorage.cs | Updates invariant references in XML docs to A.12, A.12b, B.1-2, A.4. |
| src/SlidingWindowCache/Infrastructure/Concurrency/AsyncActivityCounter.cs | Updates H.* references to the new H.1–H.3 scheme in XML docs. |
| src/SlidingWindowCache/Core/UserPath/UserRequestHandler.cs | Updates invariant reference from C.24e to C.8e in docs/comments. |
| src/SlidingWindowCache/Core/Rebalance/Execution/CacheDataExtensionService.cs | Updates cache contiguity invariant reference to A.12b. |
| src/SlidingWindowCache/Core/Planning/ProportionalRangePlanner.cs | Updates invariant references for planner behavior (E.*, D.*) to new scheme. |
| docs/storage-strategies.md | Updates invariant section headings and references to new IDs. |
| docs/state-machine.md | Updates invariant references used in state descriptions to new IDs. |
| docs/scenarios.md | Updates contiguity invariant reference to A.12b. |
| docs/invariants.md | Renumbers the formal invariant specification and adds new sub-invariants (e.g., C.8a–C.8f, D.2a, G.5). |
| docs/glossary.md | Updates H.49 references to H.3. |
| docs/diagnostics.md | Updates invariant references used in diagnostics counter descriptions. |
| docs/components/user-path.md | Updates invariant references in the user-path component overview table. |
| docs/components/state-and-storage.md | Updates invariant references in state/storage documentation. |
| docs/components/rebalance-path.md | Updates invariant references describing decision vs execution responsibilities. |
| docs/components/public-api.md | Updates invariant references tied to public API configuration/consistency docs. |
| docs/components/overview.md | Updates invariant mapping lists to the new scheme. |
| docs/components/intent-management.md | Updates invariant references in intent lifecycle documentation. |
| docs/components/execution.md | Updates invariant references in execution subsystem documentation. |
| docs/components/decision.md | Updates decision invariant range reference to D.1–D.5. |
| docs/actors.md | Updates invariant ownership lists to use the new IDs. |
| README.md | Updates serialized-access note invariant reference H.3. |
| AGENTS.md | Updates serialized-access requirement invariant reference H.3. |
💡 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.
src/SlidingWindowCache/Public/Instrumentation/ICacheDiagnostics.cs
Outdated
Show resolved
Hide resolved
…ncy across documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 30 out of 30 changed files in this pull request and generated 3 comments.
💡 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.
…nd rebalance execution
|
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation to use a new, more consistent invariant numbering scheme throughout the codebase and docs. The changes improve clarity and traceability of architectural invariants by switching from legacy numeric identifiers (e.g., "Invariant 24") to a structured format (e.g., "A.1", "C.5", "F.1"), and updating all references accordingly. No functional code changes are included; this is a documentation and specification refactor.
Invariant Numbering and Reference Updates:
AGENTS.md,README.md, anddocs/components/*.md. [1] [2] [3]docs/actors.mdto use the new scheme, grouping invariants by component responsibility (e.g., A., B., C., D., E., F., G., H.), and ensuring consistent naming. [1] [2] [3] [4] [5] [6]Component Documentation Consistency:
decision.md,execution.md,intent-management.md) to use new invariant identifiers in descriptive text, tables, and implementation notes for improved clarity. [1] [2] [3] [4] [5]These changes make the architectural invariants easier to follow, maintain, and reference across the documentation and codebase.