docs: refresh stale docs.pyth.network URLs in on-chain contract comments#3719
docs: refresh stale docs.pyth.network URLs in on-chain contract comments#37190xghost42 wants to merge 2 commits into
Conversation
Follow-up to the JS/TS README refresh (pyth-network#3718) covering the same stale `docs.pyth.network/documentation/pythnet-price-feeds/*` paths embedded in on-chain NatSpec / Move / Rust doc-comments. The legacy URL space has been retired in favour of `price-feeds/core/*` under the developer-hub content tree. URL mapping applied: - documentation/pythnet-price-feeds/best-practices -> price-feeds/core/best-practices - documentation/pythnet-price-feeds/on-demand -> price-feeds/core/use-real-time-data/pull-integration/<chain> (chain-specific page where the integration flow + fee guidance lives — i.e. /aptos, /sui, /near; the parent `use-real-time-data` index is more of a method-selection landing page) - documentation/pythnet-price-feeds/on-demand#fees -> price-feeds/core/use-real-time-data/pull-integration/<chain>#update-fee (the chain-specific pages each surface the update-fee section) - documentation/pythnet-price-feeds/cosmwasm -> price-feeds/core/contract-addresses/cosmwasm (the cw-contract example was specifically pointing readers at the contract address list, so contract-addresses/<chain> is the right landing page rather than pull-integration/<chain>) - documentation/pythnet-price-feeds (root) -> price-feeds/core/use-real-time-data/pull-integration/aptos (the one bare reference was in aptos pyth.move pointing at the integration walkthrough) This is a pure doc-comment / NatSpec change — no Move bytecode, no Solidity ABI, no Rust runtime behavior is touched. Splitting from pyth-network#3718 to keep the on-chain churn reviewable against its own consumers. Refs pyth-network#3228.
|
@0xghost42 is attempting to deploy a commit to the Pyth Network Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
🚩 Incomplete URL migration — 18 files still contain old documentation URLs
This PR updates old Pyth documentation URLs in 9 source files, but a repo-wide search reveals 18 additional files still containing the old docs.pyth.network/documentation/pythnet-price-feeds URL pattern. Notable examples include:
target_chains/aptos/contracts/Move.toml:21(same package as modified files)target_chains/ethereum/sdk/solidity/README.md:6,79(same directory as modifiedIPyth.solandPythStructs.sol)target_chains/fuel/contracts/pyth-interface/src/data_structures/price.sw:18(source code, not just docs)apps/price_pusher/src/sui/command.ts:42,49(runtime string literals)- Various README.md files across
near/,sui/,aptos/,fuel/,starknet/,hermes/,price_service/
The apps/price_pusher/src/sui/command.ts case is particularly notable since the old URLs appear in runtime string literals (user-facing CLI output), not just comments. The author may want a follow-up PR to complete the migration across all remaining files.
Was this helpful? React with 👍 or 👎 to provide feedback.
Devin re-review on pyth-network#3719 flagged two more files I missed in the initial pass: - target_chains/aptos/contracts/Move.toml:21 — package manifest comment pointed at the old aptos addresses page; retarget to `price-feeds/core/contract-addresses/aptos` - target_chains/fuel/contracts/pyth-interface/src/data_structures/price.sw:18 — Sway doc-comment on PriceStruct (Fuel contract); retarget the best-practices reference to `price-feeds/core/best-practices` Devin's other flagged paths are either already covered by an open sibling PR (pyth-network#3677 for the price_pusher CLI help strings, pyth-network#3718 for the remaining JS/TS READMEs) or are intentional (apps/developer-hub/ next.config.js holds the redirect rules that map the legacy URLs to the new layout — those MUST keep the old shape on the LHS). No code/behaviour change; pure comment retarget. Refs pyth-network#3228.
|
Thanks for the wider scan — pushed
The other paths Devin flagged are either covered elsewhere or intentional:
After #3677 + #3718 + #3719 all land, the only remaining |
… CLI strings Round-2 follow-up on Devin's pyth-network#3718 review noting 18 files still carried the stale docs.pyth.network/documentation/pythnet-price-feeds/* paths after the first JS/TS SDK README sweep. This PR adds: - target_chains/solana/sdk/js/pyth_solana_receiver/README.md — the two Hermes links and the api-instances-and-providers link were still in the legacy /price-feeds/pythnet-price-feeds/ space. Moved to /price-feeds/core/api-instances-and-providers/hermes (+ #public-endpoints anchor for the public-endpoint link) to match the rest of pyth-network#3718. - price_service/sdk/js/README.md — single bare /documentation/ root link retargeted at /price-feeds (the legacy /documentation tree has been retired in favour of the product-scoped /price-feeds + /entropy roots). - target_chains/ethereum/entropy_sdk/solidity/README.md — entropy contract-deployments link moved off /documentation/entropy/evm and onto /entropy/contract-addresses, matching the URL shape used by apps/entropy-explorer/src/errors.ts and the live entropy doc tree. - apps/price_pusher/src/sui/command.ts — the two CLI --pyth-state-id / --wormhole-state-id help strings hardcoded /documentation/pythnet-price-feeds/sui as runtime user-facing output. Retargeted at /price-feeds/core/contract-addresses/sui (the page that actually lists the Sui state IDs the operator needs). This is the only non-doc surface Devin flagged as runtime-impacting and is in scope for the JS/TS sweep. The remaining items Devin enumerated (aptos Move.toml, fuel pyth-interface .sw, on-chain Move/Solidity/Rust NatSpec comments) are covered by the parallel pyth-network#3719 on-chain branch and intentionally not duplicated here. Refs pyth-network#3228.
|
Re: Devin's "18 additional files still containing the old URL pattern" finding — most of those files are covered by the parallel #3718 (TS/JS SDK READMEs); the on-chain / non-README items Devin specifically called out are addressed in this PR by
The Sui-side runtime strings Devin flagged at After both #3718 and #3719 merge, a repo-wide |
Summary
Follow-up to #3718 (TS/JS SDK README refresh) covering the same stale
docs.pyth.network/documentation/pythnet-price-feeds/*paths embedded in on-chain NatSpec / Move / Rust doc-comments. The legacy URL space has been retired in favour ofprice-feeds/core/*under the developer-hub content tree, so these doc-comments currently link to 404s for anyone reading the source on chain or via a block explorer.Refs #3228.
URL mapping applied
documentation/pythnet-price-feeds/best-practicesprice-feeds/core/best-practicesdocumentation/pythnet-price-feeds/on-demandprice-feeds/core/use-real-time-data/pull-integration/<chain>documentation/pythnet-price-feeds/on-demand#feesprice-feeds/core/use-real-time-data/pull-integration/<chain>#update-feedocumentation/pythnet-price-feeds/cosmwasmprice-feeds/core/contract-addresses/cosmwasmdocumentation/pythnet-price-feeds(bare root)price-feeds/core/use-real-time-data/pull-integration/aptos(only call-site was inaptos/pyth.movepointing at the integration walkthrough)Notes:
on-demandmentions I picked the chain-specificpull-integration/<chain>page over the parentuse-real-time-dataindex — each chain page surfaces the update flow + fee discussion the original link was trying to point at.cw-contractexample specifically wanted the reader to find a contract address, socontract-addresses/cosmwasmis the right landing page rather thanpull-integration/cosmwasm.Files touched
Pure doc-comment / NatSpec change — no Move bytecode, no Solidity ABI, no Rust runtime behavior is affected:
target_chains/ethereum/sdk/solidity/IPyth.sol(NatSpec)target_chains/ethereum/sdk/solidity/PythStructs.sol(NatSpec)target_chains/sui/contracts/sources/price.movetarget_chains/sui/contracts/sources/pyth.movetarget_chains/aptos/contracts/sources/price.movetarget_chains/aptos/contracts/sources/pyth.movetarget_chains/cosmwasm/examples/cw-contract/src/contract.rstarget_chains/near/receiver/src/lib.rstarget_chains/near/receiver/src/state.rsSplitting from #3718 to keep the on-chain churn reviewable against its own consumers (Solidity SDK publishers, Move package upgrade authorities, NEAR contract maintainers).
Test plan
grep -rn "documentation/pythnet-price-feeds" --include="*.move" --include="*.sol" --include="*.rs"returns no remaining matches.mdxpage underapps/developer-hub/content/docs/price-feeds/core////doc-comments and//line commentspull-integration/<chain>page is preferred over the parentuse-real-time-dataforon-demandreferences in on-chain doc-comments