Skip to content

Commit 4a7bddf

Browse files
authored
Change sidebar positions and enhance onboarding notes (#562)
Updated sidebar positions and added notes regarding the bonding pool. Important: Removed from_shadow_to_prod.md from sidebar as I merged its contents with onboarding doc. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Marked "From Shadow to Prod" solver guide as draft. * Adjusted tutorial navigation order (onboarding, local test, routes integration). * Added a Telegram support channel reference. * Clarified bonding pool context in onboarding guide. * Updated the list of supported blockchain networks in endpoint documentation. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent ad10230 commit 4a7bddf

File tree

5 files changed

+9
-7
lines changed

5 files changed

+9
-7
lines changed

docs/cow-protocol/reference/core/auctions/schema.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ sidebar_position: 5
66

77
All the instances and solutions of the batch auction problem are formatted in [JSON](https://www.json.org/json-en.html). In this section, we describe these schemas.
88

9-
:::note
10-
More details can be found [here](https://docs.cow.fi/cow-protocol/reference/apis/solver).
11-
:::
9+
The api spec and schema can be found [here](https://docs.cow.fi/cow-protocol/reference/apis/solver).
1210

1311
:::caution
1412

docs/cow-protocol/tutorials/solvers/from_shadow_to_prod.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
sidebar_position: 3
3+
draft: true
34
---
45

56
# Integrating your solver
@@ -25,4 +26,4 @@ As the requirements for a bonding pool are substantial, the DAO has also set up
2526

2627
:::
2728

28-
Once a solver becomes part of a bonding pool, then the core team will proceed to allow-list the solver and connect it to the live competition.
29+
Once a solver becomes part of a bonding pool, then the core team will proceed to allow-list the solver and connect it to the live competition.

docs/cow-protocol/tutorials/solvers/local_test.md

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

55
# Locally testing a solver with the CoW Protocol orderflow

docs/cow-protocol/tutorials/solvers/onboard.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 1
33
---
44

55
# Joining The CoW Protocol Solver Competition
6+
> **_NOTE:_** In order to get connected to the shadow competition, feel free to reach out to an admin of the ["CoW Swap Solvers"](https://t.me/+2Z_-DW57meA1MDlh) group on Telegram.
7+
68
> **_NOTE:_** Most of this document assumes that you will be joining the solver competition under the CoW DAO bonding pool. If you were to set up your own bonding pool then most of the information in this document is either optional or irrelevant. To join the solver competition under your own bonding pool refer to [this document](https://docs.cow.fi/cow-protocol/reference/core/auctions/bonding-pools) and reach out to help set up the bonding pool and whitelist your solver's address.
79
810
![General process for joining the solver competition](solver_onboarding_process.jpg)
@@ -43,6 +45,7 @@ If you would like to secure your solver, you can set up a firewall and only acce
4345
### Exposed Endpoint
4446
The exposed endpoint provided must be of the following format: {base_url}/\${envName}/\${network} - for example: https://api.mysolver.io/staging/mainnet
4547
envName values: shadow, staging, prod
48+
supported networks: arbitrum-one, avalanche, base, bnb, lens, linea, mainnet, polygon, xdai (gnosis) and more are coming out!
4649

4750
### Driver configuration for your solver
4851
There are various configurations for your solver in the driver to help you optimize your solver:

docs/cow-protocol/tutorials/solvers/routes_integration.md

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

55
# Getting new routes integrated Into CoW Protocol

0 commit comments

Comments
 (0)