docs(balance): document auto-refill behavior and account-menu indicator#583
Draft
Odrec wants to merge 2 commits into
Draft
docs(balance): document auto-refill behavior and account-menu indicator#583Odrec wants to merge 2 commits into
Odrec wants to merge 2 commits into
Conversation
Add an "Auto-refill behavior" section to the Balance object docs covering: - The two conditions a refill requires (balance ≤ 0 + interval elapsed). - The two triggers (message send and balance read on app open). - The semantics of a fresh user with no lastRefill. - The green (+refillAmount) badge + "Next refill in X days" subtext shown in the account-settings popover. Tracks LibreChat PR danny-avila/LibreChat#13233.
|
Someone is attempting to deploy a commit to the LibreChat's projects Team on Vercel. A member of the Team first needs to authorize it. |
Match the refreshed UX in danny-avila/LibreChat#13233 review round: the green (+refillAmount) badge now signals refill availability (useful spending headroom) rather than a 24h "just refilled" window, and the "Next refill in X days" subtext only appears when the user is actually waiting (balance at zero and not yet eligible).
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.
Summary
Add an "Auto-refill behavior" section to the Balance object docs (
librechat_yaml/object_structure/balance.mdx). Today, the page documents each individual config field but doesn't explain when a refill actually happens, which has been a source of user confusion.The new section covers:
tokenCredits ≤ 0and the configured interval elapsed since the last refill).lastRefillset until a real refill happens;startBalancecarries them until depletion).(+refillAmount)badge for 24 h after a refill (with a timestamp tooltip), or a muted "Next refill in X days" subtext otherwise.Related
Tracks the LibreChat feature PR that introduces eager refill on balance read and the popover indicator: danny-avila/LibreChat#13233.
This docs PR is opened as a draft so it can be linked from the feature PR. It should be merged after the feature PR is merged and reaches a release, so the docs don't describe behavior that isn't yet shipped.