Skip to content

docs: caching strategy, key namespaces, and invalidation reference#962

Open
code-0-stella wants to merge 1 commit into
Disciplr-Org:mainfrom
code-0-stella:docs/cache-strategy
Open

docs: caching strategy, key namespaces, and invalidation reference#962
code-0-stella wants to merge 1 commit into
Disciplr-Org:mainfrom
code-0-stella:docs/cache-strategy

Conversation

@code-0-stella

Copy link
Copy Markdown

Description

Adds a cache strategy reference for the Redis-backed cache-aside layer and a drift test to keep the documentation aligned with the implementation.

What changed

  • Expanded docs/cache.md with:
    • cache strategy overview
    • key namespace convention (org:{orgId}:{key})
    • TTL policy and cache versioning via CACHE_VERSION
    • invalidation triggers for vault and analytics writes
    • Redis fallback and in-memory LRU behavior
    • a checklist for safely adding new cached reads
  • Added src/tests/docs.cache.test.ts to assert that the documentation references the documented namespace format, cache version, fallback behavior, and invalidation helpers.

Testing

@drips-wave

drips-wave Bot commented Jun 29, 2026

Copy link
Copy Markdown

@code-0-stella Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Author a caching strategy and key-namespace reference in docs/cache.md

2 participants