feat: add "How compatibility layer works"#3717
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
5 Skipped Deployments
|
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page to the developer hub explaining how the Pyth Pro Compatibility Layer enables existing Pyth Core consumers to receive Pyth Pro data without integration changes.
Changes:
- New MDX doc page describing architecture, data flow, components (Routers, Lazer Hermes, Compatibility Contracts), and consumer migration steps.
- Includes a Mermaid architecture diagram.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
There was a problem hiding this comment.
🚩 New doc page is not registered in any meta.json navigation manifest
The new file content/docs/pyth-pro-compatibility-layer.mdx is not listed in the root content/docs/meta.json (which only contains ["price-feeds", "express-relay", "entropy", "api-reference"]), nor in any other meta.json. This means the page won't appear in the sidebar navigation and is only reachable by direct URL. However, the existing top-level standalone docs (security.mdx, whitepaper.mdx) follow the same pattern — they are also absent from meta.json. Given the content is specifically about Pyth Pro, it could arguably live under content/docs/price-feeds/pro/ and be registered in content/docs/price-feeds/pro/meta.json, which would make it discoverable in the Pyth Pro docs sidebar. Worth confirming whether this page is intentionally an orphan or should be navigable.
Was this helpful? React with 👍 or 👎 to provide feedback.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2f10ab3af0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| --- | ||
| title: How the Pyth Pro Compatibility Layer Works | ||
| description: Understand how Pyth Core consumers can receive Pyth Pro data with no integration changes. |
There was a problem hiding this comment.
Adding this page at the docs root without updating a meta.json leaves it out of the Fumadocs sidebar/page tree: content/docs/meta.json currently lists only price-feeds, express-relay, entropy, and api-reference, and the Developer Hub README/AGENTS guidance says docs pages are organized through section meta.json manifests. In that state users browsing the Pyth Pro docs cannot discover this new compatibility-layer page from the navigation; it is only reachable by a direct URL/search.
Useful? React with 👍 / 👎.
Summary
Rationale
How has this been tested?