docs(engine): add a Tenant quota README section - #5860
Conversation
Document the pure per-tenant resource-quota evaluator (tenant-quota.ts): what evaluateTenantQuota decides (allowed + first-exhausted dimension + reason + remaining headroom), the TenantQuota/TenantUsage/QuotaDimension/ TenantQuotaDecision shapes, its decision-only scope boundary, and a verified passing/blocked usage snippet — matching the style of the package README's other pure-module sections. Closes JSONbored#5815
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ LoopOver review result - approve/merge recommendedReview updated: 2026-07-14 20:10:56 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 3 non-blocking
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.
|
Closes #5815.
Adds a
## Tenant quotasection topackages/loopover-engine/README.mddocumentingtenant-quota.ts(landed in #5801), in the same style as the package README's other pure-decision-module sections.Docs-only — a single
.mdfile, no code changed. Percodecov.yml, coverage is collected only oversrc/**/packages/loopover-engine/src/**/packages/loopover-miner/lib/**, so no Codecov gate fires (expected).Deliverable
The new section documents:
evaluateTenantQuota(usage, quota)decides —allowed+ first-exhaustedQuotaDimension+ user-facingreason+ per-dimensionremainingheadroom.TenantQuota/TenantUsage/QuotaDimension/TenantQuotaDecisionshapes (field names verified against the exports).>=-cap exhaustion, non-negative-integer normalization).Validation
tenant-quota.tsexports (TenantQuota/TenantUsage/QuotaDimension/TenantQuotaDecision).remainingnumbers and the exactreasonstring match current behavior.