Skip to content

revamp cct concept docs #2822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

revamp cct concept docs #2822

wants to merge 3 commits into from

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Jul 17, 2025

This pull request enhances the documentation and configuration for the CCIP v1.6.0 API on SVM-based blockchains, focusing on improving navigation, adding new sections, and providing more detailed descriptions for various components. Key changes include updates to the sidebar configuration, expanded API documentation, and the addition of new error codes and token pool components.

Navigation and Configuration Updates:

  • Added a new "Architecture" section under the "SVM" category in the sidebar and replaced it with an "Integration Guide" in another location. This improves the organization and accessibility of the documentation. (src/config/sidebar.ts, [1] [2]
  • Introduced new entries for "Base Token Pool Library," "BurnMint Token Pool," and "Lock-Release Token Pool" in the API reference sidebar configuration. (src/config/sidebar/ccip/api-reference/svm/v1_6_0.json, src/config/sidebar/ccip/api-reference/svm/v1_6_0.jsonR14-R25)

Documentation Enhancements:

  • Expanded metadata descriptions and added excerpts for API reference pages, providing more comprehensive and searchable summaries for components like the Router, Receiver, Messages, and Errors. (errors.mdx, [1]; index.mdx, [2]; messages.mdx, [3]; receiver.mdx, [4]; router.mdx, [5]
  • Improved the structure of the "Router" documentation by categorizing instructions (e.g., ccip_send) under "Message Sending" and adding details about router management. (router.mdx, src/content/ccip/api-reference/svm/v1.6.0/router.mdxL6-R19)

Error Handling and Token Pool Documentation:

  • Added detailed tables for new error codes, categorized into sections such as "Common Errors," "Token Administration Errors," and "Account Derivation Errors." These provide better guidance for debugging and error resolution. (errors.mdx, src/content/ccip/api-reference/svm/v1.6.0/errors.mdxL16-R121)
  • Introduced documentation for "BurnMint Token Pool" and "Lock-Release Token Pool," including their respective error codes and implementation details. (errors.mdx, [1]; index.mdx, [2]

These updates significantly improve the clarity, depth, and usability of the CCIP v1.6.0 API documentation for developers working with SVM-based blockchains.

@aelmanaa aelmanaa requested a review from a team as a code owner July 17, 2025 15:43
Copy link

vercel bot commented Jul 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Jul 18, 2025 3:51pm

Copy link
Contributor

👋 aelmanaa, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

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

Successfully merging this pull request may close these issues.

1 participant