Skip to content

docs: align use-case claims with the Ruby gem - #30

Merged
cardmagic merged 1 commit into
mainfrom
docs/align-use-case-claims
Aug 25, 2026
Merged

docs: align use-case claims with the Ruby gem#30
cardmagic merged 1 commit into
mainfrom
docs/align-use-case-claims

Conversation

@cardmagic

Copy link
Copy Markdown
Owner

Why

This package and the Ruby gem gave contradictory advice about one runtime. The README table sold per-key rate limits as a pattern, while the Ruby fit guide called a rate limiter an anti-pattern. The workflow limit lived only in docs/fit.md, so a reader who stopped at the README never met it.

What changed

Both repos now draw one line, in matching words:

  • The table row is "Quotas and expiring limits". A quota fits when one identity checks it a few times per minute, because each check is one durable ordered message with a retained history row.
  • A limiter that every request to that identity touches does not fit. That high-QPS shape is what Solid Objects Pro targets, and docs/fit.md names what it adds and its Node status.
  • The workflow limit now sits next to the workflow row: the runtime redelivers an ordered message and retries it, and does not replay a handler from a step log.

README structure

The early-release caveat moves off the first screen into a Status section at the end, with a table-of-contents entry, which is where the Ruby gem keeps the same statement. The first screen keeps the transaction caveat, because that one decides whether a reader should install anything.

Testing

  • pnpm run check passes, including the documentation link and anchor lint that covers the moved #delivery-boundaries link.
  • Prettier reports no formatting changes.
  • pnpm test: 1026 passed. The two failures are cli.test.ts copies inside stale .claude/worktrees/ checkouts that vitest still collects. They are pre-existing and unrelated to a documentation change.

Paired change

cardmagic/solid-objects-ruby#55 carries the Ruby half.

The README table sold per-key rate limits while the Ruby fit guide
called a rate limiter an anti-pattern, so the two projects gave
contradictory advice about one runtime.

Both now draw one line. A low-rate quota that a reminder refills fits,
because each check is one durable ordered message with a retained
history row. A limiter that every request to that identity touches does
not, and that high-QPS shape is what Solid Objects Pro targets. State
the workflow limit next to the workflow row rather than only in
docs/fit.md: the runtime redelivers an ordered message and retries it,
and does not replay a handler from a step log.

Move the early-release caveat off the first screen into a Status
section at the end, where the Ruby gem keeps the same statement. The
first screen keeps the transaction caveat, because that one decides
whether a reader should install anything.
@greptile-apps

greptile-apps Bot commented Aug 25, 2026

Copy link
Copy Markdown

Greptile Summary

The PR aligns the JavaScript documentation with the Ruby gem’s guidance about suitable quota, rate-limiting, and workflow use cases.

  • Reframes per-key rate limits as low-rate quotas and directs high-QPS request-path limiting to Solid Objects Pro.
  • Clarifies that workflow recovery retries ordered messages rather than replaying named steps from a step log.
  • Moves the early-release caveat into a dedicated README status section and records the documentation changes in the changelog.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

The revised quota and workflow guidance is consistent with the runtime’s durable ordered-message, retention, and retry behavior, and no actionable defects remain.

Important Files Changed

Filename Overview
README.md Refines use-case boundaries, adds workflow limitations, and relocates the early-release notice without introducing a concrete documentation defect.
docs/fit.md Distinguishes low-rate quotas from request-path limiters and accurately clarifies message-level workflow retry semantics.
CHANGELOG.md Adds an unreleased entry that consistently summarizes the README and fit-guide changes.

Reviews (1): Last reviewed commit: "docs: align use-case claims with the Rub..." | Re-trigger Greptile

@cardmagic
cardmagic merged commit 4c8662b into main Aug 25, 2026
19 checks passed
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