docs: refresh stale docs.pyth.network URLs in on-chain contract comments#3719
Open
0xghost42 wants to merge 1 commit into
Open
docs: refresh stale docs.pyth.network URLs in on-chain contract comments#37190xghost42 wants to merge 1 commit into
0xghost42 wants to merge 1 commit 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. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Contributor
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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