Revisit searcher docs (#165)

* Review overview section, split auction cycle to separate page, rename searchers section to getting started

* Revisit capitalization

* Use term 'bid phase' instead of bidding phase

* Fix remnants of bad capitalization

* Fix dApps catalog in OEV docs

* Reword getting started

* Do not use dAPI as a product

* Explain auctions at a high level

* Move auctions documentation to overview

* Update glossary

* Make dApps catalog a table instead

* Add dApp alias instead

* Update data feeds section

* Use same style for helper sections

* Remove examples, clarify some of the sections content

* Fix OEV searching docs

* Remove unmaintained /dev docs, prune README

* Fix title casing

* Clarify difference between oev proceeds and rewards

* Fix remaining TODOs

* Show OEV extended explorer

* Avoid word recapture, improve proceeds clarification

* CI fixes

* Self proofread

* Fix links

* Apply PR suggestions

* Apply PR suggestions

Author: Siegrift

.github/issue_template.md

@@ -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

.prettierignore

@@ -18,7 +18,6 @@
     "collateralized",
     "composability",
     "dapi",
-    "dapis",
     "decentrally",
     "docset",
     "docsets",

.vscode/settings.json

@@ -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
+```

CONTRIBUTING.md

@@ -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.

README.md

@@ -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(),
   },

docs/.vitepress/config.js

@@ -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

docs/dapps/index.md

@@ -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.