Skip to content

Remove directory rest api from index and sitemap. clarify contacts/programs/modules api refs#3778

Merged
gfletcher-cll merged 1 commit into
mainfrom
ccip-api-seo-discovery
May 13, 2026
Merged

Remove directory rest api from index and sitemap. clarify contacts/programs/modules api refs#3778
gfletcher-cll merged 1 commit into
mainfrom
ccip-api-seo-discovery

Conversation

@aelmanaa
Copy link
Copy Markdown
Collaborator

This pull request updates the CCIP documentation to clarify the distinction between on-chain contract/program interfaces and HTTP REST APIs, and to communicate the planned deprecation of the CCIP Directory REST API (v1) in favor of the newer CCIP Tools REST API (v2). It also improves naming consistency, platform references, and the organization of API reference materials throughout the documentation.

The most important changes are:

Deprecation and API Guidance Updates:

  • Added clear deprecation notices for the CCIP Directory REST API (v1) in OpenAPI specs, Postman collections, and documentation, and directed users to the CCIP Tools REST API (v2) for new integrations. [1] [2] [3] [4] [5] [6]
  • Updated the sitemap generation logic in astro.config.ts to exclude the v1 interactive docs page, preventing it from competing with the v2 API in search and sitemaps.

Documentation Structure and Naming:

  • Renamed and clarified section titles and descriptions for the on-chain API reference pages (EVM, Solana/SVM, Aptos, TON) to emphasize they are for contracts and program interfaces, not HTTP APIs. [1] [2] [3] [4] [5]
  • Updated links and references throughout the docs and LLM prompt files to use consistent, platform-specific naming (e.g., "Solana" instead of "SVM", "Move module interfaces" for Aptos, etc.). [1] [2] [3]

CCIP Tools Documentation Improvements:

  • Renamed "CCIP API, SDK & CLI" sections and references to "CCIP Tools API, SDK & CLI" for clarity and consistency with the v2 API branding. [1] [2]

Content and Reference Updates:

  • Improved descriptions and organization of reference sections, making a clear separation between on-chain interfaces and off-chain HTTP APIs, and updating all relevant links and section headers. [1] [2]

These changes make the documentation clearer for users, reduce confusion between v1/v2 APIs, and help guide developers toward the recommended integration paths.

@aelmanaa aelmanaa requested a review from a team as a code owner May 13, 2026 11:47
@vercel
Copy link
Copy Markdown

vercel Bot commented May 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview May 13, 2026 11:51am

Request Review

@github-actions
Copy link
Copy Markdown
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!

@gfletcher-cll gfletcher-cll merged commit 2694756 into main May 13, 2026
27 checks passed
@gfletcher-cll gfletcher-cll deleted the ccip-api-seo-discovery branch May 13, 2026 14:52
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