Skip to content

Commit beafeb3

Browse files
committed
feat: restructure docs
1 parent 28d6b39 commit beafeb3

File tree

658 files changed

+83992
-199
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

658 files changed

+83992
-199
lines changed

docs/cow-amm/README.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_position: 0
3+
sidebar_label: "About CoW AMM"
4+
---
5+
16
# CoW AMM: The First MEV-capturing AMM
27

38
CoW AMM protects LPs from LVR so they can provide liquidity with less risk and more return. CoW AMM achieves close to 5% more in TVL compared to reference pools, protects millions from LVR, and has captured over $100,000 in surplus for LPs to date.
File renamed without changes.

docs/cow-protocol/README.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar_position: 0
3+
sidebar_label: "About CoW Protocol"
4+
---
5+
16
# CoW Protocol
27

38
CoW Protocol is a meta-DEX aggregation protocol that leverages [trade intents](/cow-protocol/concepts/introduction/intents) and [fair combinatorial batch auctions](/cow-protocol/concepts/introduction/fair-combinatorial-auction) to find users better prices for trading crypto assets.
@@ -18,8 +23,7 @@ Liquidity sources include:
1823

1924
The wide range of liquidity that solvers tap into makes CoW Protocol a meta-DEX aggregator, or an aggregator of aggregators.
2025

21-
**To learn more about the concepts CoW Protocol makes use of, see [Concepts](/category/concepts).**
22-
23-
**For more info on how to use CoW Protocol or CoW Swap, see [Tutorials](/category/tutorials).**
24-
25-
**To dive into the technical details, see [Technical reference](/category/technical-reference).**
26+
**Use the sidebar to navigate through:**
27+
- **Concepts** - Learn about the fundamental concepts behind CoW Protocol
28+
- **Tutorials** - Step-by-step guides for using CoW Protocol
29+
- **Technical Reference** - APIs, SDKs, and smart contract documentation
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "API",
3+
"position": 6,
4+
"collapsible": true,
5+
"collapsed": true,
6+
"link": {
7+
"type": "generated-index"
8+
}
9+
}

docs/cow-protocol/reference/apis/driver.mdx renamed to docs/cow-protocol/apis/driver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 2
33
---
44

5-
import {SwaggerDoc} from '../../../../src/components/swagger-doc/SwaggerDoc';
5+
import {SwaggerDoc} from '../../../src/components/swagger-doc/SwaggerDoc';
66

77
# Driver API
88

docs/cow-protocol/reference/apis/orderbook.mdx renamed to docs/cow-protocol/apis/orderbook.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
import {SwaggerDoc} from '../../../../src/components/swagger-doc/SwaggerDoc';
5+
import {SwaggerDoc} from '../../../src/components/swagger-doc/SwaggerDoc';
66

77
# Order book API
88

docs/cow-protocol/reference/apis/solver.mdx renamed to docs/cow-protocol/apis/solver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
import {SwaggerDoc} from '../../../../src/components/swagger-doc/SwaggerDoc';
5+
import {SwaggerDoc} from '../../../src/components/swagger-doc/SwaggerDoc';
66

77
# Solver API
88

docs/cow-protocol/concepts/flash-loans/integrators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# How to specify an order with flash loan
66

7-
The flash loan is encoded into the [appData](/cow-protocol/reference/core/intents/app-data)'s metadata as an optional object. This information serves as a hint for the solver, but the solver ultimately can decide for a different approach in order to make the operation more optimal.
7+
The flash loan is encoded into the [appData](/cow-protocol/reference/intents/app-data)'s metadata as an optional object. This information serves as a hint for the solver, but the solver ultimately can decide for a different approach in order to make the operation more optimal.
88

99
It is important to ensure that the flash loan gas overhead is added to the slippage tolerance when creating the order.
1010

docs/cow-protocol/concepts/introduction/intents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Solvers not only scan all available on-chain liquidity (similar to a DEX aggrega
2828
The intent-based architecture of CoW Protocol also provides a number of technical benefits:
2929

3030
- Enabling [solvers](./solvers) to execute all sorts of transactions (not just trades) based on specific instructions and on-chain conditions. This powers products like [CoW Hooks](../order-types/cow-hooks) and [Programmatic Orders](../order-types/programmatic-orders)
31-
- Establishing additional rules for the way orders settle on-chain, such as guaranteeing that the trade is settled at [EBBO](/cow-protocol/reference/core/definitions#ebbo) (Ethereum best bid and offer, guaranteeing that the baseline price for the trade is what on-chain AMMs offer) and uniform clearing prices (where trades with the same token pair in the same batch are cleared at the same price)
31+
- Establishing additional rules for the way orders settle on-chain, such as guaranteeing that the trade is settled at [EBBO](/cow-protocol/reference/definitions#ebbo) (Ethereum best bid and offer, guaranteeing that the baseline price for the trade is what on-chain AMMs offer) and uniform clearing prices (where trades with the same token pair in the same batch are cleared at the same price)
3232
- Allowing users to pay gas fees in their *sell token* without needing to hold the chain-native token (like ETH) in their wallet
3333
- Eliminating fees for failed transactions
3434
- Allowing users to place multiple orders at once

docs/cow-protocol/concepts/introduction/solvers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ CoW Protocol delivers optimal price outcomes by leveraging an open solver compet
1111
Solvers are bonded third parties that execute trades on behalf of users through an [intent-based delegated execution model](intents).
1212

1313
Once a user submits an [intent](intents), the protocol groups it alongside other intents in a batch auction.
14-
As soon as a batch is "closed for orders", meaning that it stops considering new orders, the protocol runs a [competition](/cow-protocol/reference/core/auctions) where solvers submit solutions for the intents in the batch.
14+
As soon as a batch is "closed for orders", meaning that it stops considering new orders, the protocol runs a [competition](/cow-protocol/reference/auctions) where solvers submit solutions for the intents in the batch.
1515

16-
Whichever solver offers the best [solution](/cow-protocol/reference/core/auctions/the-problem#solution) for the batch auction (defined as the solver that provides the most surplus to user orders) gets to execute the orders.
16+
Whichever solver offers the best [solution](/cow-protocol/reference/auctions/the-problem#solution) for the batch auction (defined as the solver that provides the most surplus to user orders) gets to execute the orders.
1717

1818
Solvers are compensated in COW tokens for settling batches, incentivizing them to compete to find better prices and win the right to execute user intents.
1919

2020
## How Solvers Work
2121

22-
Solvers can move tokens on behalf of the user using the `ERC-20` approvals that the user granted to the [vault relayer](/cow-protocol/reference/contracts/core/vault-relayer) contract.
23-
The [settlement](/cow-protocol/reference/contracts/core/settlement) contract, meanwhile, verifies the signature of the user's intent and ensures that execution happens according to the limit price and quantity specified by the user.
22+
Solvers can move tokens on behalf of the user using the `ERC-20` approvals that the user granted to the [vault relayer](/cow-protocol/contracts/core/vault-relayer) contract.
23+
The [settlement](/cow-protocol/contracts/core/settlement) contract, meanwhile, verifies the signature of the user's intent and ensures that execution happens according to the limit price and quantity specified by the user.
2424

2525
Anyone with some DeFi knowledge and ability to code an optimizations algorithm can create a solver.

0 commit comments

Comments
 (0)