Skip to content

Conversation

@andrewshab3
Copy link

Fixes #????

xref:learn::developing-smart-contracts.adoc to the learn documentation is broken. Replace it with direct link to the contracts documentation

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@andrewshab3 andrewshab3 requested a review from a team as a code owner January 7, 2026 08:06
@changeset-bot
Copy link

changeset-bot bot commented Jan 7, 2026

⚠️ No Changeset found

Latest commit: 566d5d5

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
Contributor

coderabbitai bot commented Jan 7, 2026

Walkthrough

This pull request updates documentation in the index.adoc file. A link within the "Usage" section's usage tip is modified to redirect from an internal reference to an external URL pointing to the OpenZeppelin Contracts documentation. The surrounding prose and formatting remain unchanged.

Suggested labels

ignore-changeset

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: replacing broken cross-references with direct documentation links, which matches the changeset of updating the xref to an external OpenZeppelin Docs URL.
Description check ✅ Passed The description directly relates to the changeset, explaining that the broken xref to learn documentation was replaced with a direct link to contracts documentation, which aligns with the actual change made.
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.


📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 884e2f6 and 566d5d5.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/index.adoc
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-29T13:17:07.068Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:22-31
Timestamp: 2025-08-29T13:17:07.068Z
Learning: In OpenZeppelin contracts, virtual functions that implement interfaces should use `public` visibility instead of `external`, even for calldata-heavy functions. This is because external functions cannot be called with `super` in derived contracts, which would limit extensibility. OpenZeppelin has strong guidelines to keep all public-facing virtual functions as `public` to maintain inheritance flexibility.

Applied to files:

  • docs/modules/ROOT/pages/index.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: coverage
  • GitHub Check: slither
  • GitHub Check: tests-foundry
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests
  • GitHub Check: halmos
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
🔇 Additional comments (1)
docs/modules/ROOT/pages/index.adoc (1)

74-74: Verify the external URL destination and confirm scope of changes.

The change replaces a broken internal xref with an external URL to OpenZeppelin documentation. Before approval, please confirm:

  1. The URL https://docs.openzeppelin.com/contracts is accessible and points to appropriate content about "creating a new project and compiling your contracts"
  2. Whether this is the only file affected by this fix (the PR title mentions "links" in plural, suggesting multiple replacements)

Additionally, per the PR objectives, note that Tests and Changeset entry checklist items are still incomplete. Please ensure these are addressed before merge.


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.

@Amxx Amxx changed the base branch from master to typo-fixes January 7, 2026 10:27
@Amxx Amxx added this to the typo-fixes milestone Jan 7, 2026
@Amxx Amxx added documentation Inline comments, guides, and examples. ignore-changeset labels Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Inline comments, guides, and examples. ignore-changeset

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants