Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes and expands the documentation set (tests, plugin, dev guides, and contracts), primarily by restructuring the Contracts docs into an “Overview” hierarchy, adding new CCIP flow docs, and adjusting sidebar ordering/labels.
Changes:
- Reordered multiple doc sidebars (tests, plugin, dev guides, contracts) via
sidebar_position/ categorypositionupdates. - Added new Contracts documentation pages/sections (Contract Development Guide, Deployable, CCIP component/flow docs, Router UI docs, Receive/Send executor docs).
- Refined titles/headings/labels across existing Contracts docs for consistency and readability.
Reviewed changes
Copilot reviewed 50 out of 58 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tests/index.md | Adjust Tests overview ordering |
| docs/tests/ccip-e2e.md | Adjust CCIP E2E ordering |
| docs/tests/category.yaml | Move Tests category position |
| docs/plugin/release.md | Adjust Release doc ordering |
| docs/plugin/relayer/logpoller/query.md | Adjust Logpoller Query ordering |
| docs/plugin/relayer/logpoller/category.yaml | Adjust Log Poller category position |
| docs/plugin/relayer/category.yaml | Adjust Relayer category position |
| docs/plugin/category.yaml | Adjust Plugin category position |
| docs/dev-guides/nix/getting-started.md | Adjust Nix Getting Started ordering |
| docs/dev-guides/nix/category.yaml | Adjust Nix category position |
| docs/dev-guides/index.md | Adjust Dev Guides overview ordering |
| docs/dev-guides/explorer/usage.md | Adjust Explorer Usage ordering |
| docs/dev-guides/explorer/development.md | Adjust Explorer Development ordering |
| docs/dev-guides/cross-repo-dependency-dev.md | Promote Cross-Repo guide in sidebar |
| docs/dev-guides/category.yaml | Adjust Developer Guides category position |
| docs/contracts/test.md | Retitle contract testing page; reorder |
| docs/contracts/overview/token-transfer-notation-convention.md | Rename/re-ID notation convention; adjust sidebar |
| docs/contracts/overview/mcms/rbac_timelock.md | Retitle RBACTimelock page |
| docs/contracts/overview/libraries/upgradeable.md | Retitle Upgradeable library page; reorder |
| docs/contracts/overview/libraries/ownable_2step.md | Retitle Ownable2Step library page; reorder |
| docs/contracts/overview/libraries/merkle_multi_proof.md | Retitle MerkleMultiProof page; reorder |
| docs/contracts/overview/libraries/index.md | Add composability guidance and library listing |
| docs/contracts/overview/jetton/category.yaml | Adjust Jetton category position |
| docs/contracts/overview/index.md | Update overview links; add Deployable link |
| docs/contracts/overview/examples/index.md | Adjust Examples overview ordering |
| docs/contracts/overview/examples/async.md | Adjust Async example ordering |
| docs/contracts/overview/examples/category.yaml | Adjust Examples category position |
| docs/contracts/overview/deployable.md | Add Deployable contract documentation |
| docs/contracts/overview/ccip/token-registry.md | Reorder Token Registry doc in CCIP section |
| docs/contracts/overview/ccip/router/user-interface/sender.md | Rename sender sidebar label; reorder |
| docs/contracts/overview/ccip/router/user-interface/receiver.md | Rename receiver sidebar label; add “stuck messages” section |
| docs/contracts/overview/ccip/router/user-interface/index.md | Add Router UI overview doc |
| docs/contracts/overview/ccip/router/user-interface/category.yaml | Adjust Router UI category position |
| docs/contracts/overview/ccip/router/index.md | Add Router overview doc |
| docs/contracts/overview/ccip/router/category.yaml | Adjust Router category position |
| docs/contracts/overview/ccip/onramp/token-transfer.md | Add token-transfer onramp flow doc |
| docs/contracts/overview/ccip/onramp/send-executor.md | Add SendExecutor design doc |
| docs/contracts/overview/ccip/onramp/index.md | Normalize OnRamp naming/casing |
| docs/contracts/overview/ccip/onramp/arbitrary-msg.md | Add arbitrary-message onramp flow doc |
| docs/contracts/overview/ccip/onramp/category.yaml | Adjust Onramp category position |
| docs/contracts/overview/ccip/offramp/token-transfer.md | Reorder token-transfer offramp flow doc |
| docs/contracts/overview/ccip/offramp/receive-executor.md | Add ReceiveExecutor design doc |
| docs/contracts/overview/ccip/offramp/merkle-root.md | Reorder MerkleRoot doc |
| docs/contracts/overview/ccip/offramp/index.md | Normalize OffRamp naming/casing; reorder |
| docs/contracts/overview/ccip/offramp/arbitrary-msg.md | Reorder arbitrary-message offramp flow doc |
| docs/contracts/overview/ccip/offramp/category.yaml | Adjust Offramp category position |
| docs/contracts/overview/ccip/index.md | Add CCIP section overview with diagrams/links |
| docs/contracts/overview/ccip/flow.md | Add CCIP flow overview page |
| docs/contracts/overview/ccip/fee-quoter.md | Reorder FeeQuoter doc |
| docs/contracts/overview/ccip/category.yaml | Adjust CCIP category position |
| docs/contracts/overview/category.yaml | Adjust Overview category position |
| docs/contracts/index.md | Reorder Contracts landing page; add overview links |
| docs/contracts/format.md | Retitle Format page; reorder |
| docs/contracts/development.md | Add Contract Development Guide |
| docs/contracts/coverage.md | Add slug; retitle coverage page; reorder |
| docs/contracts/build.md | Retitle build page; reorder |
| docs/contracts/benchmarking.md | Add slug; retitle benchmarking page; reorder |
| docs/contracts/category.yaml | Adjust Contracts category position |
Comments suppressed due to low confidence (6)
docs/contracts/overview/ccip/router/user-interface/receiver.md:66
- Spelling/grammar issues in this new section: “ccip explorer” (likely should be capitalized consistently, e.g. “CCIP Explorer”), “might ran ouf of gas” → “might run out of gas”.
docs/contracts/overview/token-transfer-notation-convention.md:38 - Multiple typos/grammar issues in this sentence (e.g., “this transfers”, “envolve”, “foward”). Consider rewriting to something like “these transfers … involve … forward …” to improve readability.
docs/contracts/overview/ccip/onramp/category.yaml:2 - The sidebar label uses “Onramp” while the doc title/heading uses “OnRamp”. Consider updating the label for consistent naming in the navigation.
docs/contracts/overview/ccip/offramp/category.yaml:2 - The sidebar label uses “Offramp” while the doc title/heading uses “OffRamp”. Consider updating the label for consistent naming in the navigation.
docs/contracts/overview/ccip/router/user-interface/receiver.md:58 - The Mermaid message payload in this diagram appears to be missing a closing
}for the outerCCIPReceive { ... }structure (the earlierNote over R:/R ->> U:lines showCCIPReceive { execId, message: { ... }without closing the outer brace). This can break Mermaid rendering; please balance the braces in both Happy/Failure path diagrams.
docs/contracts/overview/ccip/offramp/token-transfer.md:5 - The “Jetton Transfer Notation Convention” link in this page currently uses
../token-transfer-notation-convention.md, which would resolve todocs/contracts/overview/ccip/token-transfer-notation-convention.md(doesn’t exist). It should point to the notation convention doc atdocs/contracts/overview/token-transfer-notation-convention.md(likely../../token-transfer-notation-convention.mdfrom this directory).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
vicentevieytes
previously approved these changes
Apr 8, 2026
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.
Uh oh!
There was an error while loading. Please reload this page.