docs: surface catalog capabilities, add llms.txt links, custody + changelog conventions#430
Open
bidzyyys wants to merge 4 commits into
Open
docs: surface catalog capabilities, add llms.txt links, custody + changelog conventions#430bidzyyys wants to merge 4 commits into
bidzyyys wants to merge 4 commits into
Conversation
…ngelog conventions
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR updates repository documentation only: top-level guidance files add custody, contribution, style, and discovery notes; contracts and math READMEs expand package descriptions; and allowance/timelock docs add or adjust lifecycle and capability text. ChangesDocumentation updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #430 +/- ##
==========================================
+ Coverage 96.59% 96.62% +0.02%
==========================================
Files 34 34
Lines 3405 3405
Branches 794 794
==========================================
+ Hits 3289 3290 +1
Misses 70 70
+ Partials 46 45 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@contracts/allowance/README.md`:
- Around line 50-52: Clarify the description of spendable_now<T> in the
allowance README so it is presented as an advisory ceiling rather than a
guaranteed exact amount. Update the Inspect section wording near
spendable_now<T> to explicitly note that the quoted value can still fail under
same-checkpoint contention, and make sure the phrasing is consistent with the
surrounding API names like allowance<T>, expiry<T>, contains<T>, and
balance_value<T>.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 15ce8bda-023f-425f-960c-3a7564994589
📒 Files selected for processing (9)
ARCHITECTURE.mdCONTRIBUTING.mdSTYLEGUIDE.mdcontracts/README.mdcontracts/allowance/README.mdcontracts/timelock/README.mdllms.txtmath/README.mdmath/fixed_point/README.md
ericnordelo
approved these changes
Jul 3, 2026
ericnordelo
left a comment
ericnordelo
left a comment
Member
There was a problem hiding this comment.
Great improvements. LGTM!
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
2 participants
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.
Docs-only pass that improves discoverability of existing capabilities for integrators and AI agents, and codifies the conventions behind it. No code or tests touched.
Discoverability coverage
Surfaced hidden-but-public capabilities at catalog level, each backed by a real, named function in the package README:
rounding+conversions/casts; package README adds a Rounding line (ceil/floor) and the SD29x9abs/negate/remhelpers.on-chain queryable allowance state; package README gains an "Inspect" lifecycle step (allowance/spendable_now/expiry/contains/balance_value).dependency chaining+permissionless execution; package README Module Snapshot updated to match (predecessor gating, open-executor).Conventions
CHANGELOG.md, grouped by package, per Keep a Changelog).PriorityQueueto the bounded-collections list.Summary by CodeRabbit