api3dao / vitepress-docs

Next generation of api3-docs
https://docs.api3.org/
MIT License
11 stars 15 forks source link

Document Signed APIs in dAPIs #831

Closed Siegrift closed 2 weeks ago

Siegrift commented 3 weeks ago

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.

github-actions[bot] commented 3 weeks ago

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 commented 3 weeks ago

@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 commented 3 weeks ago

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 commented 3 weeks ago

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 commented 3 weeks ago

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.

Ashar2shahid commented 3 weeks ago

oev-docs will be the version where we will remove airnode, qrng and move to only dAPIs and OEV Network for now I will incoperate the documentation of signed APIs in dAPIs and leave the other sections unchanged

wkande commented 3 weeks ago

for now I will incoperate the documentation of signed APIs in dAPIs and leave the other sections unchanged

Meaning do the changes Enamuel already has this PR setup to do?

Siegrift commented 3 weeks ago

Meaning do the changes Enamuel already has this PR setup to do?

The ones for Signed APIs should be enough (although they could be extended in the future).

I agree with all of you that removing the content is too intrusive and better do that some other time. I'm leaving this PR to @Ashar2shahid to finalize.

Ashar2shahid commented 2 weeks ago

Closing this in favor for #838