Skip to content
This repository has been archived by the owner on Aug 26, 2024. It is now read-only.

fix: remove use of references.json chainNames field #1243

Merged
merged 4 commits into from
Dec 31, 2023
Merged

Conversation

dcroote
Copy link
Contributor

@dcroote dcroote commented Dec 27, 2023

Closes #1242. Since these old docs are deprecated, I've opted for skipping the display of chains that aren't present in chains.json rather than invest in upgrading these docs to use @api3/chains.

@dcroote dcroote requested a review from wkande December 27, 2023 19:30
@dcroote dcroote self-assigned this Dec 27, 2023
Copy link

github-actions bot commented Dec 27, 2023

Visit the preview URL for this PR (updated for commit 648a401):

https://api3-docs--pr1243-dcroote-issue1242-eg5moqg7.web.app

(expires Sun, 07 Jan 2024 19:10:25 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: d319eb7cbe610768342d5dc1b5cd1f3aed912886

@wkande
Copy link
Member

wkande commented Dec 27, 2023

Your logic makes sense to me for the Airnode contract addresses.

There may be another issue here with the dAPI Chain and Contracts page: https://old-docs.api3.org/dapis/reference/chains.html

  1. There are chains without contract addresses, meaning they may not be relevant chains. This may be due to the endpoint returning more data as time has progressed.
  2. It is using an endpoint that may go away
  3. It uses DapiServer and not Api3ServerV1 and ProxyFactory

I guess the data is part of what dAPIs were back then but not now. But that endpoint probably needs to go. Let me propose this idea which is somewhat laziness. Since reading dAPIs is not possible the way the old docs describe we provide a link back to the new docs Chains and Contracts page?

Having said that a lot of what is in the old docs for dAPIs is legacy in that the user really needs to move on to the new docs to use dAPIs. But at the very least the Chain and Contracts page is very problematic I think.

Another idea is to stop using the endpoint and create a markdown table of what was the data at the time. Probably the better solution

@dcroote
Copy link
Contributor Author

dcroote commented Dec 29, 2023

But that endpoint probably needs to go. Let me propose this idea which is somewhat laziness. Since reading dAPIs is not possible the way the old docs describe we provide a link back to the new docs Chains and Contracts page?

Good thought- I agree it's best to refer to the new docs and I've done so in the latest commit- take a look and let me know what you think.

Copy link
Member

@wkande wkande left a comment

Choose a reason for hiding this comment

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

LGTM

docs/dapis/reference/chains.md Outdated Show resolved Hide resolved
@dcroote dcroote merged commit f7c539c into main Dec 31, 2023
5 of 6 checks passed
@dcroote dcroote deleted the dcroote/issue1242 branch December 31, 2023 19:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove use of chainNames and networks from references.json
2 participants