Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b50ed64
Review overview section, split auction cycle to separate page, rename…
Siegrift Mar 4, 2025
86ca66e
Revisit capitalization
Siegrift Mar 5, 2025
0153686
Use term 'bid phase' instead of bidding phase
Siegrift Mar 5, 2025
623a684
Fix remnants of bad capitalization
Siegrift Mar 5, 2025
4d5c116
Fix dApps catalog in OEV docs
Siegrift Mar 5, 2025
91d1e2b
Reword getting started
Siegrift Mar 6, 2025
5011535
Do not use dAPI as a product
Siegrift Mar 6, 2025
8f1d368
Explain auctions at a high level
Siegrift Mar 6, 2025
b3715fe
Move auctions documentation to overview
Siegrift Mar 6, 2025
73b728e
Update glossary
Siegrift Mar 6, 2025
53040d5
Make dApps catalog a table instead
Siegrift Mar 6, 2025
1624a72
Add dApp alias instead
Siegrift Mar 6, 2025
5489bc0
Update data feeds section
Siegrift Mar 6, 2025
dbaef2a
Use same style for helper sections
Siegrift Mar 6, 2025
414be21
Remove examples, clarify some of the sections content
Siegrift Mar 6, 2025
d51231d
Fix OEV searching docs
Siegrift Mar 11, 2025
41257a9
Remove unmaintained /dev docs, prune README
Siegrift Mar 11, 2025
8f302bc
Fix title casing
Siegrift Mar 11, 2025
79337b9
Clarify difference between oev proceeds and rewards
Siegrift Mar 11, 2025
ac99604
Fix remaining TODOs
Siegrift Mar 11, 2025
aff3708
Show OEV extended explorer
Siegrift Mar 11, 2025
6c7024d
Avoid word recapture, improve proceeds clarification
Siegrift Mar 11, 2025
a9765d5
CI fixes
Siegrift Mar 11, 2025
4b90aa1
Self proofread
Siegrift Mar 11, 2025
97eed1e
Fix links
Siegrift Mar 11, 2025
959ef53
Apply PR suggestions
Siegrift Mar 12, 2025
26d7fda
Apply PR suggestions
Siegrift Mar 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .github/issue_template.md

This file was deleted.

7 changes: 0 additions & 7 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,13 @@ pnpm-lock.yaml
/docs/.vitepress/public
/docs/.vuepress/styles

#dev
/docs/dev/using-metamask/src/HelloWorld.sol.js
/docs/dev/using-metamask/src/HelloWorld.sol


/docs/public/img
/docs/public/api3-whitepaper-v1.0.3.pdf

# assets
/docs/reference/ois/latest/assets
/docs/reference/airnode/latest/assets
/docs/reference/dao-members/assets
/docs/dapis/reference/assets
/docs/reference/chainapi/assets
/docs/reference/qrng/assets
/docs/oev-searchers/assets
/docs/dapis/assets
1 change: 0 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"collateralized",
"composability",
"dapi",
"dapis",
"decentrally",
"docset",
"docsets",
Expand Down
104 changes: 15 additions & 89 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,29 @@
## Contributor's Guide
# Contributors' guide

Welcome to the Api3 Documentation Repository. This guide will help you get
started with contributing to the Api3 documentation.

## How to get started

The Api3 Docs uses [VitePress](https://vitepress.dev/), a Vue-powered static
Welcome to the Api3 documentation repository. This guide will help you get
started with contributing to the Api3 documentation. The docs use [VitePress](https://vitepress.dev/), a Vue-powered static
site generator. Follow the steps below to get started.

Make sure to check out https://docs.api3.org/dev/ for more details and
information about getting started and making a contribution to the Api3 Docs.

### Pre-requisites

- [Node.js](https://nodejs.org/en/) (version 20 or higher).
- Unix/macOS/WSL for the scripts to work properly.

### Installation

```bash
pnpm install
```

### Running the local development server

Run the following command to start the local development server on port `5173`:

```bash
pnpm docs:dev
```

### Structure

The Api3 Docs repository is structured as follows:

- `/docs/dapis`: Explore section within the Api3 Docs.
- `/docs/oev`: All the guides that demonstrate the use of Airnode, QRNG and
dAPIs.
- `/docs/reference`: Contains the core documentation for Airnode, QRNG and
dAPIs.

Each section will have a `sidebar.js` file that contains the sidebar structure
for that section.

`/_components`: Contains the custom vue components used in the Api3 Docs.

[Check this out](https://docs.api3.org/dev/docsets.html) for more info about the
structure of the docs.

### Building the static site

```bash
pnpm docs:build
```

### Prettier Formatting

Make sure to run the following command before submitting a PR to format the
markdown. The Github action will check for prettier formatting:

```bash
pnpm format
```

### Formatting and Styling

You can use markdown to format the content. Check out the
[docs development section](https://docs.api3.org/dev/) for more info. Some
useful links:

- [Page styling](https://docs.api3.org/dev/page-styling.html)
- [Formatting guides](https://docs.api3.org/dev/oev-format.html)
- [VitePress Containers](https://docs.api3.org/dev/containers.html)

### Git Workflow:

- `main` branch: for the current live site
[docs.api3.org](https://docs.api3.org)

[Check this out](https://docs.api3.org/dev/firebase.html#repo-branches) for more
info about the branches.

### Submitting an Issue
## Submitting an issue

You can submit an issue if you find any bugs or have any feature requests.
Please make sure to check if the issue already exists before submitting a new
one.

You can:

- Submit an issue for a bug.
- Submit an issue for a feature request.
- Submit an issue for a documentation request.
## Making a pull request

### Making a PR

After making changes in a feature branch, submit a PR against the `main` branch.
After making changes in a feature branch, submit a pull request (PR) against the `main` branch.
Make sure to link the corresponding GitHub Issue in the PR description e.g.
`Closes #1`. You will be able to see the changes within a Firebase preview
deployment that is unique to the PR. The PR will be reviewed by the team and
merged into the `main` branch, which will result in the changes going live into
production.

### Getting started

After cloning the repo locally, install the dependencies and run the docs locally.

```bash
pnpm install
pnpm docs:dev
```
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# OEV docs preview
# OEV docs

This technical documentation is a fork of the official
[Api3 technical documentation](https://docs.api3.org). The intent is to develop
OEV-related documentation here privately then merge into the official repo when
ready.
> The main API3 documentation

## Instructions
## Contributing

To install deps:

```sh
pnpm install
```

and to run in dev mode:

```sh
pnpm run docs:dev
```

## Deployment

Firebase is used to host the `oev-docs` technical documentation. A preview
deployment is generated for every PR, while the main deployment is updated with
every merge to the `main` branch. The url for the main deployment is:
[https://oev-docs.web.app](https://oev-docs.web.app).
Head out to [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
1 change: 0 additions & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ export default {
sidebar: {
'/dapps/': require('../dapps/sidebar.js'),
'/oev-searchers/': require('../oev-searchers/sidebar.js'),
'/dev/': require('../dev/sidebar.js'),
},
nav: nav(),
},
Expand Down
2 changes: 1 addition & 1 deletion docs/dapps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Rent-seeking third parties can exploit this fact to extract funds from data feed

[Oracle Extractable Value (OEV)](https://medium.com/api3/oracle-extractable-value-oev-13c1b6d53c5b) is a subset of MEV that oracles have priority in extracting by batching additional operations with their updates.
Furthermore, instead of searching for such OEV opportunities themselves, oracles can auction off this privilege.
Api3 holds transparent and permissionless auctions for OEV opportunities on OEV Network, and [pays](/dapps/oev-rewards/) the auction proceeds to the respective dApps.
Api3 holds transparent and permissionless auctions for OEV opportunities on OEV Network, and [pays](/dapps/oev-rewards/) 80% of the auction proceeds to the respective dApps.
OEV Rewards serves as a new and sustainable revenue stream for dApps.

::: info ⚠️ Disclaimer
Expand Down
2 changes: 1 addition & 1 deletion docs/dapps/oev-rewards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pageHeader: dApps → OEV Rewards
dApps that use traditional data feeds are constantly exploited by MEV bots that manipulate the order of operations around individual data feed updates.
In practice, this causes dApps to suffer significant and continuous financial losses.
As the antidote, Api3's OEV Network auctions off to OEV searchers the privilege to determine the order of operations around data feed updates.
The resulting auction proceeds are paid to the dApp in the form of OEV Rewards.
80% of resulting auction proceeds are paid to the dApp in the form of OEV Rewards.
Assuming competitive auctions, OEV Rewards will be equal to the amount that would otherwise have been lost to the MEV bots.

Api3 data feeds work identically to traditional data feeds, which means that you do not need to modify your contracts in any way to use them.
Expand Down
Binary file removed docs/dev/assets/images/ssr-cloudflare.png
Binary file not shown.
Binary file removed docs/dev/assets/images/version-search.png
Binary file not shown.
63 changes: 0 additions & 63 deletions docs/dev/containers.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/dev/docsets.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/dev/firebase.md

This file was deleted.

59 changes: 0 additions & 59 deletions docs/dev/frontmatter.md

This file was deleted.

Loading
Loading