Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Signed APIs in dAPIs #831

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Document Signed APIs in dAPIs #831

wants to merge 5 commits into from

Conversation

Siegrift
Copy link
Contributor

@Siegrift Siegrift commented Oct 3, 2024

I'm opening a PR to document Signed APIs in the dAPIs section, to fix the now outdated content of how the push oracle works. I've copied over the content from the yet unreleased docs. Refer to the commits for better clarity of the changes.

@Siegrift Siegrift self-assigned this Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Visit the preview URL for this PR (updated for commit 92bb0f6):

https://vitepress-docs--pr831-document-dapis-c40tnztm.web.app

(expires Thu, 10 Oct 2024 16:34:44 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e4c5db1acb62b36273dc03718b86834917dea599

@wkande
Copy link
Member

wkande commented Oct 3, 2024

@Siegrift @dcroote

Not sure we should do this PR until we verify that removing Airnode and OIS is needed. In fact if they are not then why don't we shut down this repo and just use oev-docs?

See the preview above to see what I mean. Notice the top menu bar no longer has Airnode, OIS, e.t.c.

Another thought. If there is a sections in oev-docs for dAPIs then why do we have the same in viterpress-docs?

@Siegrift
Copy link
Contributor Author

Siegrift commented Oct 3, 2024

Not sure we should do this PR until we verify that removing Airnode and OIS is needed. In fact if they are not then why don't we shut down this repo and just use oev-docs?

They are. The problem with using oev-docs is that it contains some items regarding the new version of OEV auctions which we don't want yet to be public. So I only moved the dAPIs content.

See the preview above to see what I mean. Notice the top menu bar no longer has Airnode, OIS, e.t.c.

Yeah, that was the intention.

Another thought. If there is a sections in oev-docs for dAPIs then why do we have the same in viterpress-docs?

This is only a short term solution. Maybe in a month or so, the vitepress docs can be archived and we'll only use oev-docs then (and maybe change the repo name).

@wkande
Copy link
Member

wkande commented Oct 3, 2024

It just seems odd that from the home page you can still get to the Airnode/OID/DAO/etc sections. But if this makes sense to everyone. Before we merge can we wait on Derek to speak?

@dcroote
Copy link
Collaborator

dcroote commented Oct 3, 2024

Frankly I'm quite against the aspects of this PR that modify Airnode / OIS etc. We should make the transition smoothly and coherently at once. This is a haphazard deletion of some things and not others without any simultaneous announcements or relocations of the content that will persist in other locations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants