Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
cffc30d
docs: update FaultyDataSource documentation for clarity and accuracy
Feb 26, 2026
a180510
refactor: improve diagnostics and data source handling; refactor: upd…
Feb 27, 2026
a212875
refactor: improve thread safety and synchronization in CopyOnReadStor…
Feb 27, 2026
7d0c12f
refactor: update documentation to reflect changes in cache state mana…
Feb 27, 2026
788732b
refactor: revise ICacheDiagnostics interface to focus on key events
Feb 27, 2026
4c5fc8a
refactor: improve user request handling logic for cache scenarios and…
Feb 27, 2026
295a31e
refactor: improve code structure and remove redundant elements;
Feb 27, 2026
0b74fca
refactor: update method signatures and improve data handling in vario…
Feb 27, 2026
bf90291
docs: README and documentation files have been updated for clarity an…
Feb 27, 2026
823b2e1
chore: update documentation links and structure in various markdown f…
Feb 28, 2026
1edd9c5
test: unit tests for cache data extension service and async activity …
Feb 28, 2026
c37e313
style: code formatting has been improved in NoRebalanceRangePlanner a…
Feb 28, 2026
9af8f1f
docs: README file has been updated to include current performance bas…
Feb 28, 2026
e965773
Update docs/components/rebalance-path.md
blaze6950 Feb 28, 2026
2300da4
refactor: improve diagnostics and data handling in IDataSource and Ra…
Feb 28, 2026
e62bdb7
refactor: update user-path documentation for improved clarity and acc…
Feb 28, 2026
08c570d
refactor: improve documentation for CopyOnReadStorage and clarify loc…
Feb 28, 2026
61d288c
Merge remote-tracking branch 'origin/refactor/improve-code' into refa…
Feb 28, 2026
65b6caa
Update docs/components/public-api.md
blaze6950 Feb 28, 2026
d9bf588
Update docs/components/public-api.md
blaze6950 Feb 28, 2026
81fa246
Update docs/components/intent-management.md
blaze6950 Feb 28, 2026
6290264
refactor(execution): improve execution controller structure and seman…
Mar 1, 2026
8aa123b
Merge remote-tracking branch 'origin/refactor/improve-code' into refa…
Mar 1, 2026
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
10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@ bin/
obj/
/packages/
riderModule.iml
/_ReSharper.Caches/
/_ReSharper.Caches/

# IDE / user-specific
.idea/
.vs/
*.DotSettings.user

# Stray / OS artifacts
nul
47 changes: 25 additions & 22 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ using Intervals.NET;
using Intervals.NET.Domain.Abstractions;
using SlidingWindowCache.Core.Planning;
using SlidingWindowCache.Core.State;
using SlidingWindowCache.Infrastructure.Instrumentation;
using SlidingWindowCache.Public.Instrumentation;
```

### XML Documentation
Expand Down Expand Up @@ -207,7 +207,7 @@ catch (Exception ex)
### Concurrency Patterns

**Single-Writer Architecture (CRITICAL):**
- User Path: READ-ONLY (never mutates Cache, LastRequested, or NoRebalanceRange)
- User Path: READ-ONLY (never mutates Cache, IsInitialized, or NoRebalanceRange)
- Rebalance Execution: SINGLE WRITER (sole authority for cache mutations)
- Serialization: Channel-based with single reader/single writer (intent processing loop)

Expand Down Expand Up @@ -305,29 +305,32 @@ refactor: AsyncActivityCounter lock has been removed and replaced with lock-free
- Documentation may be outdated; long-term goal is synchronization with code

### Documentation Update Map
| File | Update When | Focus |
|------|-------------|-------|
| `README.md` | Public API changes, new features | User-facing examples, configuration |
| `docs/invariants.md` | Architectural invariants changed | System constraints, concurrency rules |
| `docs/architecture-model.md` | Concurrency mechanisms changed | Thread safety, synchronization primitives |
| `docs/component-map.md` | New components, major refactoring | Component catalog, dependencies |
| `docs/actors-and-responsibilities.md` | Component responsibilities changed | Actor roles, explicit responsibilities |
| `docs/cache-state-machine.md` | State transitions changed | State machine specification |
| `docs/storage-strategies.md` | Storage implementation changed | Strategy comparison, performance |
| `docs/scenario-model.md` | Temporal behavior changed | Scenario walkthroughs, sequences |
| `docs/diagnostics.md` | New diagnostics events | Instrumentation guide |
| `benchmarks/*/README.md` | Benchmark changes | Performance methodology, results |
| `tests/*/README.md` | Test architecture changes | Test suite documentation |
| XML comments (in code) | All code changes | Component purpose, invariant references |

| File | Update When | Focus |
|-------------------------------|------------------------------------|-----------------------------------------|
| `README.md` | Public API changes, new features | User-facing examples, configuration |
| `docs/invariants.md` | Architectural invariants changed | System constraints, concurrency rules |
| `docs/architecture.md` | Concurrency mechanisms changed | Thread safety, coordination model |
| `docs/components/overview.md` | New components, major refactoring | Component catalog, dependencies |
| `docs/actors.md` | Component responsibilities changed | Actor roles, explicit responsibilities |
| `docs/state-machine.md` | State transitions changed | State machine specification |
| `docs/storage-strategies.md` | Storage implementation changed | Strategy comparison, performance |
| `docs/scenarios.md` | Temporal behavior changed | Scenario walkthroughs, sequences |
| `docs/diagnostics.md` | New diagnostics events | Instrumentation guide |
| `docs/glossary.md` | Terms or semantics change | Canonical terminology |
| `benchmarks/*/README.md` | Benchmark changes | Performance methodology, results |
| `tests/*/README.md` | Test architecture changes | Test suite documentation |
| XML comments (in code) | All code changes | Component purpose, invariant references |

## Architecture References

**Before making changes, consult these critical documents:**
- `docs/invariants.md` - System invariants (33KB) - READ THIS FIRST
- `docs/architecture-model.md` - Architecture and concurrency model
- `docs/actors-and-responsibilities.md` - Component responsibilities
- `docs/component-map.md` - Detailed component catalog (86KB)
- `README.md` - User guide and examples (32KB)
- `docs/invariants.md` - System invariants - READ THIS FIRST
- `docs/architecture.md` - Architecture and concurrency model
- `docs/actors.md` - Actor responsibilities and boundaries
- `docs/components/overview.md` - Component catalog (split by subsystem)
- `docs/glossary.md` - Canonical terminology
- `README.md` - User guide and examples

**Key Invariants to NEVER violate:**
1. Cache Contiguity: No gaps allowed in cached ranges
Expand All @@ -342,6 +345,7 @@ refactor: AsyncActivityCounter lock has been removed and replaced with lock-free
- `src/SlidingWindowCache/Public/WindowCache.cs` - Main cache facade
- `src/SlidingWindowCache/Public/IDataSource.cs` - Data source contract
- `src/SlidingWindowCache/Public/Configuration/` - Configuration classes
- `src/SlidingWindowCache/Public/Instrumentation/` - Diagnostics

**Core Logic:**
- `src/SlidingWindowCache/Core/UserPath/` - User request handling (read-only)
Expand All @@ -351,7 +355,6 @@ refactor: AsyncActivityCounter lock has been removed and replaced with lock-free

**Infrastructure:**
- `src/SlidingWindowCache/Infrastructure/Storage/` - Storage strategies
- `src/SlidingWindowCache/Infrastructure/Instrumentation/` - Diagnostics
- `src/SlidingWindowCache/Infrastructure/Concurrency/` - Async coordination

## CI/CD
Expand Down
Loading