Skip to content

docs: say when to use it, and when something else fits better - #64

Merged
AlexeyShalaev merged 1 commit into
masterfrom
docs/when-to-use
Oct 27, 2026
Merged

AlexeyShalaev merged 1 commit into
masterfrom
docs/when-to-use

Conversation

@AlexeyShalaev

Copy link
Copy Markdown
Member

Summary

The README and the docs home page promised "exactly once" and "at-most-once message processing", while the architecture page and agents.md say the guarantee is one execution per key while Redis is up and at-least-once when it is down (unless on_storage_error="raise"). This brings the front pages in line with that:

  • the tagline and intro describe a result cache with an in-flight reservation and link to the exact guarantee
  • "Graceful Degradation" becomes "Fails open or closed", naming both modes
  • the message-queue use case no longer says at-most-once
  • emoji and "production-ready" wording removed from both pages

It also adds a "When to use it, and when not" section: HTTP-only middleware for a few endpoints, a unique constraint when the write has a natural key, failing closed or a database-backed record when a repeat is unacceptable during a Redis outage, and no sync API or non-Redis store out of the box.

Type of change

  • Documentation update

Checklist

  • zensical build --clean passes locally, no warnings

@codecov

codecov Bot commented Oct 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AlexeyShalaev
AlexeyShalaev merged commit 3873fd9 into master Oct 27, 2026
8 checks passed
@AlexeyShalaev
AlexeyShalaev deleted the docs/when-to-use branch October 27, 2026 16:06
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.

1 participant