docs(solidity): point isAllowed readers to JS SDK viewACL (NOXFB-71) - #90
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves cross-discoverability between the Solidity ACL docs and the JS SDK by adding a callout pointing readers of ACL.isAllowed(...) to the JS SDK’s viewACL method, while also cleaning up the page’s admonition layout and heading hierarchy.
Changes:
- Fixed heading hierarchy by changing the
Usagesection from###to##. - Consolidated two consecutive
::: warningblocks underallowinto a single warning with bullet points. - Added a
::: tipunderisAllowedreferencing the JS SDKhandleClient.viewACL(handle)docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
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
Improves discoverability between the Solidity reference and the JS SDK. Builders find the on-chain
ACL.isAllowed(handle, account)Solidity function and wrongly assume there is no JS equivalent — buthandleClient.viewACL(handle)already covers it. This adds a cross-reference so JS SDK users don't reach for the contract call directly.While in the file, two small UI/UX cleanups on the same page.
Changes
src/references/solidity-library/methods/core-primitives/access-control.md(single file):::: tipcallout afterisAllowedpointing JS SDK users toviewACL.::: warningcallouts underallowinto a single warning with two bullets (pre-condition + permanence) — avoids two consecutive red blocks.Usagewas###while every other section is##, breaking the heading hierarchy (h1 → h3 → h2).Notes
prettier --checkpasses andvitepress buildcompletes successfully.