Skip to content

docs: use API xref for SignatureChecker in multisig guide#6456

Open
suyua9 wants to merge 1 commit intoOpenZeppelin:masterfrom
suyua9:btc-c-oz-scan
Open

docs: use API xref for SignatureChecker in multisig guide#6456
suyua9 wants to merge 1 commit intoOpenZeppelin:masterfrom
suyua9:btc-c-oz-scan

Conversation

@suyua9
Copy link
Copy Markdown

@suyua9 suyua9 commented Apr 3, 2026

Summary\n- replace the hard-coded GitHub link in the multisig guide with the existing API xref\n- keep the guide inside the docs site's own navigation instead of sending readers to a branch-specific repository URL\n\n## Testing\n- not run (docs link target update only)

@suyua9 suyua9 requested a review from a team as a code owner April 3, 2026 08:20
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 3, 2026

⚠️ No Changeset found

Latest commit: ab33b13

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 78afdd45-ad48-443f-9174-0306207062ae

📥 Commits

Reviewing files that changed from the base of the PR and between 9cfdccd and ab33b13.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/multisig.adoc

Walkthrough

This is a documentation-only change that replaces an external hyperlink to OpenZeppelin's SignatureChecker.sol source code with an internal AsciiDoc cross-reference pointing to the project's own API documentation. The change updates the multisig documentation page to use xref:api:utils/cryptography.adoc#SignatureChecker instead of the external link.

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: replacing a hard-coded link with an AsciiDoc cross-reference for SignatureChecker in the multisig documentation guide.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation for replacing the external GitHub link with an internal API cross-reference and clarifying the testing approach for this docs-only change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant