docs: refresh stale docs.pyth.network URLs across TS/JS SDK READMEs#3718
docs: refresh stale docs.pyth.network URLs across TS/JS SDK READMEs#37180xghost42 wants to merge 1 commit into
Conversation
The `docs.pyth.network/documentation/pythnet-price-feeds/*` URL space has
been retired in favour of the `price-feeds/core/*` layout under the
developer-hub app (see e.g. apps/developer-hub/src/app/llms-price-feeds-core.txt
and apps/developer-hub/content/docs/price-feeds/core/). Most chain SDK
READMEs and a couple of the app READMEs still point at the dead URLs,
which 404 for any developer who follows them.
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 lives)
- documentation/pythnet-price-feeds/hermes#public-endpoint(s) ->
price-feeds/core/api-instances-and-providers/hermes#public-endpoints
- documentation/pythnet-price-feeds/hermes#hermes-node-providers ->
price-feeds/core/api-instances-and-providers/hermes#node-providers
(the new page uses `## Node Providers`, so the anchor slug is
`#node-providers`)
- documentation/pythnet-price-feeds/near ->
price-feeds/core/use-real-time-data/pull-integration/near
- documentation/pythnet-price-feeds/sui ->
price-feeds/core/use-real-time-data/pull-integration/sui
(the iota README's inline code comment was already specifically
pointing readers at the Sui state/package IDs, so it now points
at contract-addresses/sui)
- apps/price_pusher/README.md was already partially updated to
`price-feeds/api-instances-and-providers/hermes`, but that path
has been moved under `core/` since; switched to the new canonical
`price-feeds/core/api-instances-and-providers/hermes` and added
the missing `#public-endpoints` anchor
Refs pyth-network#3228, complements pyth-network#3677 (which only refreshed the Sui-specific
links in the main README and price_pusher CLI help text).
On-chain contract NatSpec / Move / Rust doc-comments contain the same
stale paths and will be refreshed in a follow-up PR to keep this diff
JS-only.
|
@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}
There was a problem hiding this comment.
🚩 Old documentation URLs remain in non-Markdown source files
Several source code files still contain old docs.pyth.network/documentation/pythnet-price-feeds/ URLs that were not updated by this PR: apps/price_pusher/src/sui/command.ts, target_chains/cosmwasm/examples/cw-contract/src/contract.rs, target_chains/ethereum/sdk/solidity/PythStructs.sol, target_chains/ethereum/sdk/solidity/IPyth.sol, target_chains/aptos/contracts/Move.toml, target_chains/near/receiver/src/lib.rs, and target_chains/near/receiver/src/state.rs. These are in code comments rather than README files, so they may be intentionally out of scope for this PR, but they should be updated in a follow-up to avoid stale documentation references.
Was this helpful? React with 👍 or 👎 to provide feedback.
1 participant
Summary
The
docs.pyth.network/documentation/pythnet-price-feeds/*URL space has been retired in favour of theprice-feeds/core/*layout under the developer-hub app (seeapps/developer-hub/content/docs/price-feeds/core/andapps/developer-hub/src/app/llms-price-feeds-core.txt/route.ts). Most chain SDK READMEs and a couple of the app READMEs still point at the dead URLs, which 404 for any developer who follows them.Refs #3228, complements #3677 (which only refreshed the Sui-specific links in the main README and
price_pusherCLI help text).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/hermes#public-endpoint(s)price-feeds/core/api-instances-and-providers/hermes#public-endpointsdocumentation/pythnet-price-feeds/hermes#hermes-node-providersprice-feeds/core/api-instances-and-providers/hermes#node-providersdocumentation/pythnet-price-feeds/nearprice-feeds/core/use-real-time-data/pull-integration/neardocumentation/pythnet-price-feeds/suiprice-feeds/core/use-real-time-data/pull-integration/sui(andcontract-addresses/suifor the iota README's inline code comment that specifically pointed at state/package IDs)Notes:
on-demandmentions I picked the chain-specificpull-integration/<chain>page (rather than the parentuse-real-time-dataindex) because each chain page already has the integration flow + fee guidance the original link was trying to surface.## Node Providers, so the auto-generated slug is#node-providers(nohermes-prefix). Public-endpoint anchor was inconsistent in old READMEs (#public-endpointvs#public-endpoints) — both are now normalized to#public-endpoints(matching## Public Endpointson the new page).apps/price_pusher/README.mdhad previously been partially updated toprice-feeds/api-instances-and-providers/hermes, but that path has since moved undercore/; this PR switches it toprice-feeds/core/api-instances-and-providers/hermesand adds the missing#public-endpointsanchor for the public-endpoint reference.Scope
JS/TS SDK READMEs and app READMEs only — keeping this diff documentation-only for a clean review:
apps/hermes/client/js/README.mdapps/hermes/server/README.mdapps/price_pusher/README.mdprice_service/client/js/README.mdtarget_chains/aptos/sdk/js/README.mdtarget_chains/ethereum/sdk/solidity/README.mdtarget_chains/ethereum/sdk/stylus/README.mdtarget_chains/fuel/sdk/js/README.mdtarget_chains/near/README.mdtarget_chains/starknet/sdk/js/README.mdtarget_chains/sui/README.mdtarget_chains/sui/sdk/js-iota/README.mdtarget_chains/sui/sdk/js/README.mdThe on-chain contract NatSpec / Move doc-comments / Rust doc-comments contain the same stale paths (Solidity
IPyth.sol/PythStructs.sol, Sui/Aptospyth.move/price.move, NEARreceiver/src/{lib,state}.rs, CosmWasmcw-contract/src/contract.rs) and will be refreshed in a follow-up PR so this diff stays JS-only and the on-chain churn can be reviewed against its own consumers.Test plan
grep -rn "documentation/pythnet-price-feeds" --include="*.md"returns no remaining matches in the touched scope.mdxpage underapps/developer-hub/content/docs/price-feeds/core/apps/developer-hub/content/docs/price-feeds/core/api-instances-and-providers/hermes.mdxpull-integration/<chain>page is the preferred landing target over the parentuse-real-time-dataindex for "on-demand"-style references