docs: README — 0.2 rate limiting + token audit fields#25
Merged
Conversation
The README config reference still listed only the legacy per-IP cap. Add a Rate limiting section covering the five RateLimitOptions dimensions and their over-limit behaviour, a RateLimiting row in the config table, and note the `tokens` field now present on assistant/escalated audit events. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
The root README's configuration reference was stale for 0.2: it documented only the legacy
MaxRequestsPerIpPerMinutecap and made no mention of the five-dimensionRateLimitingoptions or the token usage now recorded in the audit log.RateLimitOptionsdimensions, a config example, and an over-limit behaviour table (queue / delay / prompt / reject / degrade).RateLimitingrow to the configuration table.tokensfield now present onmessage(assistant) andescalatedaudit events, and thatrate_limitedevents name the tripped dimension.Docs only. The NuGet-facing
NUGET.mdalready covered these; this brings the GitHub README in line.🤖 Generated with Claude Code