[NONEVM-2301] Tidy docs

[patricios-space]

• Sort doc directories
• Fix broken links
• Provide frontmatter metadata
• Lint Markdown files
• Add missing diagrams

[Copilot]

Pull request overview

This PR tidies and reorganizes the repository documentation into a more navigable, Docusaurus-style structure with consistent sidebars/categories, fixed relative links, and additional CCIP/relayer content organization.

Changes:

• Added frontmatter (id, title, sidebar_*) across docs and introduced _category_.yaml files to define sidebar structure.
• Added overview/index pages for major doc sections (Plugin, Contracts, CCIP subareas, Libraries, Tests, Developer Guides).
• Updated/rewired internal links and moved/replaced older “README-style” docs with structured pages.

Reviewed changes

Copilot reviewed 82 out of 82 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
docs/tests/integration-tests.md	Add Docusaurus frontmatter
docs/tests/index.md	New tests overview page
docs/tests/ccip-e2e.md	Add Docusaurus frontmatter
docs/tests/category.yaml	New sidebar category for Tests
docs/plugin/release.md	Add Docusaurus frontmatter
docs/plugin/relayer/logpoller/query.md	Add frontmatter; minor formatting
docs/plugin/relayer/logpoller/index.md	New Log Poller overview page
docs/plugin/relayer/logpoller/category.yaml	New sidebar category for Log Poller
docs/plugin/relayer/index.md	New Relayer overview page
docs/plugin/relayer/category.yaml	New sidebar category for Relayer
docs/plugin/index.md	New Plugin overview page
docs/plugin/build.md	Add Docusaurus frontmatter
docs/plugin/category.yaml	New sidebar category for Plugin
docs/libraries/tonutils.md	Fix/update example documentation link
docs/libraries/index.md	New Libraries overview page
docs/libraries/category.yaml	New sidebar category for Libraries
docs/index.md	New top-level docs landing page
docs/getting-started.md	Add frontmatter; fix Nix guide link
docs/dev-guides/nix/index.md	New Nix overview page
docs/dev-guides/nix/getting-started.md	New Nix getting-started guide (moved from misc)
docs/dev-guides/nix/builds.md	Add Docusaurus frontmatter
docs/dev-guides/nix/category.yaml	New sidebar category for Nix guides
docs/dev-guides/index.md	New Developer Guides overview page
docs/dev-guides/explorer/usage.md	Add Docusaurus frontmatter
docs/dev-guides/explorer/index.md	New Explorer overview page
docs/dev-guides/explorer/development.md	Fix relative links to source files; add frontmatter
docs/dev-guides/explorer/category.yaml	New sidebar category for Explorer guides
docs/dev-guides/cross-repo-dependency-dev.md	Add frontmatter; markdown formatting cleanup
docs/dev-guides/category.yaml	New sidebar category for Developer Guides
docs/contracts/test.md	Add Docusaurus frontmatter
docs/contracts/overview/mcms/rbac_timelock.md	Add Docusaurus frontmatter
docs/contracts/overview/mcms/index.md	New MCMS overview page
docs/contracts/overview/mcms/category.yaml	New sidebar category for MCMS
docs/contracts/overview/libraries/upgradeable.md	Add Docusaurus frontmatter
docs/contracts/overview/libraries/ownable_2step.md	Add frontmatter; markdown/table formatting fixes; add diagram reference
docs/contracts/overview/libraries/merkle_multi_proof.md	Add frontmatter; spacing tweak
docs/contracts/overview/libraries/index.md	New Libraries overview page (contracts overview)
docs/contracts/overview/libraries/category.yaml	New sidebar category for Libraries (contracts overview)
docs/contracts/overview/jetton/index.md	Add frontmatter; mermaid formatting changes
docs/contracts/overview/jetton/category.yaml	New sidebar category for Jetton
docs/contracts/overview/index.md	New Contracts Overview landing page
docs/contracts/overview/examples/index.md	New Examples overview page
docs/contracts/overview/examples/async.md	Add frontmatter to async examples doc
docs/contracts/overview/examples/category.yaml	New sidebar category for Examples
docs/contracts/overview/category.yaml	New sidebar category for Contracts Overview
docs/contracts/overview/README.md	Removed legacy overview README (replaced by index pages)
docs/contracts/index.md	Add frontmatter; update overview links; add CCIP link
docs/contracts/format.md	Add frontmatter; markdown spacing cleanup
docs/contracts/coverage.md	Add frontmatter; code-fence formatting cleanup
docs/contracts/ccip/token-transfer-notation-convention.md	Add frontmatter
docs/contracts/ccip/token-registry.md	Add frontmatter; clarify “not supported” in heading
docs/contracts/ccip/router/user-interface/sender.md	New Sender UI page
docs/contracts/ccip/router/user-interface/receiver.md	Add frontmatter; rename heading to Receiver UI
docs/contracts/ccip/router/user-interface/index.md	New Router UI overview page
docs/contracts/ccip/router/user-interface/category.yaml	New sidebar category for Router UI
docs/contracts/ccip/router/index.md	New Router overview page
docs/contracts/ccip/router/category.yaml	New sidebar category for Router
docs/contracts/ccip/onramp/token-transfer.md	Add frontmatter; fix internal links
docs/contracts/ccip/onramp/send-executor.md	New SendExecutor page
docs/contracts/ccip/onramp/index.md	New Onramp overview page
docs/contracts/ccip/onramp/arbitrary-msg.md	New arbitrary-message onramp flow page
docs/contracts/ccip/onramp/category.yaml	New sidebar category for Onramp
docs/contracts/ccip/offramp/token-transfer.md	New token-transfer offramp page (placeholder)
docs/contracts/ccip/offramp/receive-executor.md	New ReceiveExecutor page
docs/contracts/ccip/offramp/merkle-root.md	New MerkleRoot page
docs/contracts/ccip/offramp/index.md	New Offramp overview page
docs/contracts/ccip/offramp/arbitrary-msg.md	Add frontmatter; expand offramp flow diagrams and links
docs/contracts/ccip/offramp/category.yaml	New sidebar category for Offramp
docs/contracts/ccip/index.md	New CCIP overview page
docs/contracts/ccip/flow.md	Add frontmatter; update UI links to new Router UI docs
docs/contracts/ccip/fee-quoter.md	New FeeQuoter page
docs/contracts/ccip/category.yaml	New sidebar category for CCIP
docs/contracts/build.md	Add Docusaurus frontmatter
docs/contracts/benchmarking.md	Add Docusaurus frontmatter; trailing whitespace cleanup
docs/contracts/category.yaml	New sidebar category for Contracts
docs/README.md	Removed legacy docs README (replaced by docs/index.md)
docs/.misc/dev-guides/nix/getting-started.md	Removed misc Nix getting-started (moved to docs/dev-guides/nix/)

Comments suppressed due to low confidence (2)

docs/contracts/ccip/index.md:58

• This file ends with a second ## Topics header that has no content, which will fail common markdown linters and reads like an accidental duplicate. Remove the duplicate header or populate it with the intended content.

## Topics

- [Flow Overview](./flow.md)
- [Token Transfer Notation Convention](./token-transfer-notation-convention.md)

## Topics

docs/contracts/overview/jetton/index.md:22

• The Mermaid frontmatter YAML under config: uses tab indentation (e.g., before messageAlign) and the diagram body also uses tabs. YAML does not allow tabs for indentation, so this can break Mermaid parsing/rendering and markdown linting. Replace tabs with spaces (consistent indentation) inside the Mermaid code block.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.