docs: align use-case claims with the Ruby gem - #30
Merged
Conversation
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 SummaryThe PR aligns the JavaScript documentation with the Ruby gem’s guidance about suitable quota, rate-limiting, and workflow use cases.
Confidence Score: 5/5The 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
Reviews (1): Last reviewed commit: "docs: align use-case claims with the Rub..." | Re-trigger Greptile |
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.
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:
docs/fit.mdnames what it adds and its Node status.README structure
The early-release caveat moves off the first screen into a
Statussection 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 checkpasses, including the documentation link and anchor lint that covers the moved#delivery-boundarieslink.pnpm test: 1026 passed. The two failures arecli.test.tscopies 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.