Skip to content

docs(sui): point Sui integration links at the new docs URL#3677

Open
0xghost42 wants to merge 2 commits into
pyth-network:mainfrom
0xghost42:fix/3228-sui-docs-link
Open

docs(sui): point Sui integration links at the new docs URL#3677
0xghost42 wants to merge 2 commits into
pyth-network:mainfrom
0xghost42:fix/3228-sui-docs-link

Conversation

@0xghost42
Copy link
Copy Markdown

@0xghost42 0xghost42 commented May 11, 2026

Summary

Closes #3228.

The Sui READMEs link to docs.pyth.network/documentation/pythnet-price-feeds/sui, which returns HTTP 404 since the docs site reshuffle. @merolish confirmed on the issue that the current URL is docs.pyth.network/price-feeds/core/contract-addresses/sui.

Change

Update both Sui-specific occurrences of the broken URL:

  • target_chains/sui/README.md (the link the bug report points at)
  • target_chains/sui/sdk/js-iota/README.md (the same URL in a code comment showing where to find Pyth/Wormhole state IDs)

Verification

$ curl -sI -o /dev/null -w "%{http_code}\n" https://docs.pyth.network/documentation/pythnet-price-feeds/sui
404
$ curl -sI -o /dev/null -w "%{http_code}\n" https://docs.pyth.network/price-feeds/core/contract-addresses/sui
200

Out of scope

Other documentation/pythnet-price-feeds/<topic> URLs in the repo (best-practices, on-demand, hermes, near, ...) cover non-Sui topics and the new URL for each is not necessarily a 1:1 mapping with the old one. Happy to follow up with a broader sweep in a separate PR if you'd like.


Open in Devin Review

Closes pyth-network#3228.

The Sui READMEs link to
``docs.pyth.network/documentation/pythnet-price-feeds/sui``, which
returns HTTP 404 since the docs site reshuffle. The maintainer
confirmed the current URL on the issue:
``docs.pyth.network/price-feeds/core/contract-addresses/sui`` (HTTP 200).

Update both occurrences:
  * ``target_chains/sui/README.md`` (the link the bug report points at)
  * ``target_chains/sui/sdk/js-iota/README.md`` (the same URL in a code
    comment showing where to find Pyth/Wormhole state IDs)

Verified with ``curl -sI``:
  * old URL -> 404
  * new URL -> 200

Other ``documentation/pythnet-price-feeds/<topic>`` URLs in the repo
are out of scope for this fix; they cover non-Sui topics and the new
URL for each is not 1:1 with the old one.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

@0xghost42 is attempting to deploy a commit to the Pyth Network Team on Vercel.

A member of the Team first needs to authorize it.

devin-ai-integration[bot]

This comment was marked as resolved.

Per Devin Review on pyth-network#3677, the same stale URL appears in two CLI
`--help` descriptions in apps/price_pusher/src/sui/command.ts.
Update both to match the rest of the PR.
@0xghost42
Copy link
Copy Markdown
Author

Thanks for the catch — pushed 890dd8c which updates both CLI help descriptions in apps/price_pusher/src/sui/command.ts to the new URL. PR now covers all Sui-specific stale references.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 new potential issue.

View 1 additional finding in Devin Review.

Open in Devin Review

const wallet: SignerWithProvider = getWallet();
// Get the state ids of the Pyth and Wormhole contracts from
// https://docs.pyth.network/documentation/pythnet-price-feeds/sui
// https://docs.pyth.network/price-feeds/core/contract-addresses/sui
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Other old-style documentation URLs remain in the same IOTA README

The js-iota README at target_chains/sui/sdk/js-iota/README.md still contains two other old-style URLs that were not updated by this PR: line 23 (docs.pyth.network/documentation/pythnet-price-feeds/on-demand) and line 155 (docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoints). These are different pages (on-demand and hermes) rather than the Sui contract addresses page, so they may intentionally be out of scope for this PR. However, if the goal is to migrate all docs URLs, these should be updated too — possibly as a follow-up.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@0xghost42
Copy link
Copy Markdown
Author

Re: Devin review findings —

  1. price_pusher CLI help URLs — already addressed in commit 890dd8c, which updated both apps/price_pusher/src/sui/command.ts:42 and :49 to the new URL. Devin's follow-up review confirmed resolution.

  2. Other documentation/pythnet-price-feeds/* URLs in target_chains/sui/sdk/js-iota/README.md (on-demand, hermes) — intentionally out of scope. Each documentation/pythnet-price-feeds/<topic> path on the old docs site does not have a clean 1:1 mapping under the new structure (on-demand and hermes live elsewhere than the sui contract-addresses page), so I kept this PR narrow to what Pyth docs returning Error 404 when clicked #3228 flagged. Happy to follow up with a broader sweep PR if you'd like to tackle them together.

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.

Pyth docs returning Error 404 when clicked

1 participant