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

Update dAPI reference and guides section #723

Merged
merged 20 commits into from
Apr 29, 2024
Merged

Update dAPI reference and guides section #723

merged 20 commits into from
Apr 29, 2024

Conversation

vanshwassan
Copy link
Contributor

Updated the /guides and /reference section for dAPIs for the upcoming market updates.

  • Removed references regarding Self-funded and Managed dAPIs
  • Updated the guides and reference sections for the new market updates and OEV
  • Removed the Gelato guide for funding dAPI sponsor wallets

Copy link
Contributor

github-actions bot commented Apr 16, 2024

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

https://vitepress-docs--pr723-dapi-updates-mcwhhugu.web.app

(expires Mon, 06 May 2024 04:27:49 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e4c5db1acb62b36273dc03718b86834917dea599

Copy link
Contributor

@Ashar2shahid Ashar2shahid left a comment

Choose a reason for hiding this comment

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

Did some changes @dcroote can you take a look before I merge

@Ashar2shahid Ashar2shahid requested a review from dcroote April 24, 2024 00:26
@Ashar2shahid Ashar2shahid marked this pull request as ready for review April 24, 2024 00:26
Copy link
Collaborator

@dcroote dcroote left a comment

Choose a reason for hiding this comment

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

Reads very well overall 👍

Needs update:

`@api3/contracts/v0.8/interfaces` library, which defines a function called

I found a couple of pages under Explore that need similar updating with regards to self/managed:

404:

- [Subscribing to Self-Funded dAPIs](/guides/dapis/subscribing-self-funded-dapis/index.md)

This whole page:

are two types of dAPIs:
- Self-funded dAPIs
- Managed dAPIs
## Self-funded dAPIs
Self-funded dAPIs currently rely on a single first-party oracle. They offer dApp
owners the opportunity to make use of data feeds with minimal up-front
commitment and are accessible
[permissionlessly](https://www.gemini.com/en-US/cryptopedia/what-is-permissionless-crypto-permissionlessness-blockchain)
for developers.
### Using Self-funded dAPIs
Self-funded dAPIs require any dApp owner to provide funds into a sponsor wallet.

docs/guides/dapis/subscribing-to-dapis/index.md Outdated Show resolved Hide resolved
docs/reference/dapis/understand/index.md Outdated Show resolved Hide resolved
docs/reference/dapis/understand/index.md Outdated Show resolved Hide resolved
docs/reference/dapis/understand/wallets.md Show resolved Hide resolved
@vanshwassan
Copy link
Contributor Author

Reads very well overall 👍

Needs update:

`@api3/contracts/v0.8/interfaces` library, which defines a function called

I found a couple of pages under Explore that need similar updating with regards to self/managed:

404:

- [Subscribing to Self-Funded dAPIs](/guides/dapis/subscribing-self-funded-dapis/index.md)

This whole page:

are two types of dAPIs:
- Self-funded dAPIs
- Managed dAPIs
## Self-funded dAPIs
Self-funded dAPIs currently rely on a single first-party oracle. They offer dApp
owners the opportunity to make use of data feeds with minimal up-front
commitment and are accessible
[permissionlessly](https://www.gemini.com/en-US/cryptopedia/what-is-permissionless-crypto-permissionlessness-blockchain)
for developers.
### Using Self-funded dAPIs
Self-funded dAPIs require any dApp owner to provide funds into a sponsor wallet.

There's going to be another PR for the explore section with all the updated stuff.

Copy link
Collaborator

@dcroote dcroote left a comment

Choose a reason for hiding this comment

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

One minor change still needed, otherwise LGTM.

I might suggest merging this when the explore PR is also ready, otherwise there will be broken links and discordant content.

docs/guides/dapis/read-a-dapi/index.md Outdated Show resolved Hide resolved
@vanshwassan
Copy link
Contributor Author

One minor change still needed, otherwise LGTM.

I might suggest merging this when the explore PR is also ready, otherwise there will be broken links and discordant content.

I have merged Explore_2.1_March17 into this branch and closed #726. Also updated the links.

@Ashar2shahid Ashar2shahid merged commit e9a7b9e into main Apr 29, 2024
2 checks passed
@Ashar2shahid Ashar2shahid deleted the dapi-updates branch April 29, 2024 04:29
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.

4 participants