Skip to content
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

fix ccip v1.5.1 api ref #2263

Merged
merged 2 commits into from
Jan 17, 2025
Merged

fix ccip v1.5.1 api ref #2263

merged 2 commits into from
Jan 17, 2025

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Jan 16, 2025

This pull request includes several updates to the Chainlink CCIP API documentation and configuration files. The most important changes include adding new API references, updating page availability configurations, and enhancing documentation for specific interfaces and contracts.

Updates to API References:

  • Added ITypeAndVersion to the API references for versions 1.5.0 and 1.5.1 in the sidebar configuration files. [1] [2]
  • Added Ownable2Step and Ownable2StepMsgSender to the API reference for version 1.5.1 in the sidebar configuration file.

Configuration Updates:

  • Updated page-availability.ts to include ownable-2-step and ownable-2-step-msg-sender as not available in version 1.5.0.

Documentation Enhancements:

  • Added detailed API documentation for the ITypeAndVersion interface in v1.5.0.
  • Enhanced the documentation for BurnFromMintTokenPool in v1.5.1, including additional details on state variables and functions.
  • Improved the documentation for BurnMintERC20 in v1.5.1, including new sections on events, errors, state variables, and functions.

Copy link

vercel bot commented Jan 16, 2025

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

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Jan 17, 2025 3:59pm

@aelmanaa aelmanaa marked this pull request as ready for review January 17, 2025 16:03
@aelmanaa aelmanaa merged commit 6b86519 into main Jan 17, 2025
10 checks passed
@aelmanaa aelmanaa deleted the ccip/fix-api-ref branch January 17, 2025 16:19
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.

2 participants