Skip to content

Comments

dApp docs update#156

Merged
bbenligiray merged 19 commits intomainfrom
dapp-docs-update
Feb 9, 2025
Merged

dApp docs update#156
bbenligiray merged 19 commits intomainfrom
dapp-docs-update

Conversation

@bbenligiray
Copy link
Member

@bbenligiray bbenligiray commented Feb 9, 2025

Closes #138

@Ashar2shahid @RiVal-cz for visibility

  • I extended the Quickstart and Using API3 Market sections to mention the new "Skip OEV Rewards"/"Earn OEV Rewards" interface on the Integrate page
  • I stopped using "communal" and "dApp-specific" for proxies, referred to the "Skip OEV Rewards"/"Earn OEV Rewards" interface wherever possible. They are in some @api3/contracts function names so I couldn't remove it altogether (it's not a big deal imo).
  • I removed the manual proxy deployment section, considering that even the self-service OEV user doesn't need it anymore
  • I removed all references to a dApp alias. The dApp "applies for OEV Rewards" and we "register" them, which makes them show up on the Integrate page of the market. They get assigned an alias during the registration but they don't need to know much about this. The only point they hear about this is when they run the @api3/contracts CLI command, which is arguably not needed anymore (you can just send them Market links for each proxy), and Ashar gives them the command including the arguments so they don't need to know their alias. (Previously the alias was important for the self-service OEV user because they used it to deploy their proxies manually.)

I didn't address @Siegrift 's concerns about not documenting what exactly constitutes the total OEV Rewards number because the docs currently don't refer to this number in any way. Once that goes up on api3.org, I'm planning to add a section discussing that under the OEV Rewards section.

@github-actions
Copy link

github-actions bot commented Feb 9, 2025

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

https://oev-docs--pr156-dapp-docs-update-qe9drfbu.web.app

(expires Sun, 16 Feb 2025 16:28:52 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 6915b094b5ba83fde754632ba50c1ee9406d433f

@bbenligiray bbenligiray merged commit 2d88bc2 into main Feb 9, 2025
3 checks passed
@bbenligiray bbenligiray deleted the dapp-docs-update branch February 9, 2025 16:31

## Integration information

Clicking "Integrate" on a data feed page will display the information needed for a [contract integration.](/dapps/integration/contract-integration.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

It would make sense to mention that switching later is not a problem.

Copy link
Member Author

Choose a reason for hiding this comment

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

That will just cause them to skip OEV Rewards and it will be a pain to have them switch later on

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.

Update the integrate screen screenshot once the design gets updated

2 participants