Repository navigation
Fix stale guidance on the Data Feeds getting-started page - #4459
Merged
Merged
Conversation
"each chain and each Data Feed types" follows "each" with a plural noun, so the sentence does not parse. The plural likely came from using-data-feeds.mdx, which says the code is "the same across all EVM-compatible blockchains and Data Feed types" - correct there because it follows "all". Carried into a sentence built on "each chain and each", it needs the singular. Only the trailing "s" changes; the rest of the sentence, including its capitalization of "Data Feed", is left alone.
Starknet styles the name as one word, and the page this link points to is itself titled "Using Data Feeds on Starknet", so the link text disagreed with its own destination. Only the visible label changes. The href stays /data-feeds/starknet, so nothing about where the link goes has moved.
The caution named only Arbitrum, OP, and Metis, but the L2 Sequencer Uptime Feeds page lists eleven networks with mainnet proxy addresses: Arbitrum, BASE, Celo, Mantle, MegaETH, Metis, OP, Scroll, Soneium, X Layer, and zkSync. BASE has its own mainnet proxy address on that page, so a developer deploying this contract to Base saw no mention of their chain in the examples. Add it alongside the existing names rather than replacing one: dropping Metis would leave another supported network unnamed. The closing sentence now points at "the complete list of supported networks" so the examples cannot be misread as exhaustive.
The old sentence was conditional on novelty ("If you are new to
smart contract development..."), so it never stated the requirements
as requirements. The wallet-on-Sepolia-plus-ETH need first appeared
in a caution inside the deploy steps, after the reader had already
opened Remix and started compiling.
State the requirement up front and get the cost right: only deploying
the contract spends testnet ETH, because the sample's function is a
view function and reading is free. That makes the "no LINK" point
concrete rather than a checklist item the reader has to tick off for
something they do not need.
Link the quickstart at the funding section so readers land on the
steps, and trim the deploy-section aside to a pointer so the faucet
and MetaMask instructions are not repeated twice on one page.
The instruction hung on the control type ("checkbox"), but
price-feeds/index.mdx already describes the same control as
"selecting More Details".
The addresses page is client-rendered from its feeds JSON, so the
control's current form could not be confirmed from the served HTML.
Reusing the sibling page's neutral wording means the step no longer
depends on it being a checkbox.
The final step tells readers to read decimals() from the feed contract "instead of hardcoding it" but never shows the call, and the sample contract never uses it. A reader who follows the advice literally hits a dead end: the deployed sample exposes no decimals() getter to call. Say the omission out loud so readers are not sent looking for the function in Remix, and point at the API reference for the call to make in their own contracts rather than restating the canonical guidance in price-feeds/index.mdx.
getChainlinkDataFeedLatestAnswer() destructures latestRoundData() with bare commas for roundId, startedAt, updatedAt, and answeredInRound, keeping only answer. That is reasonable for a clarity-first example, but it is also the pattern a reader will copy into production unchanged. Say that the omission is deliberate, and separate the two fields: the API reference marks answeredInRound as deprecated, while updatedAt is the value the overview page tells consumers to check. Link that guidance rather than restating it.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
👋 ianblenke, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
dev-dist
approved these changes
Nov 19, 2026
This branch was successfully deployed
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
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.
closes #4458
Description
Fixes the defects reported in #4458 on the Data Feeds getting-started page, and updates the generated
llms-full.txtmirror for that page sovalidate-llmsstays green.Changes
each Data Feed types->each Data Feed type)StarkNet->Starknet); the href is unchangedselecting **More Details**)decimals()in the getting-started guide: the sample exposes no such function, so the call is scoped to the reader's own contracts with a link to the API referenceansweredInRoundis deprecated,updatedAtis not, with a link to the existing guidanceEach commit updates both the page and its
llms-full.txtmirror for the same change.Notes for review
npm run buildwas not run.llms-full.txtwas mirrored per commit by hand because the dependencies could not be installed in my environment. Please runnpm run generate:llmsto confirm the mirror is byte-identical.