Change sidebar positions and enhance onboarding notes #562
Conversation
Updated sidebar position and added notes regarding the bonding pool.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded@tamir-cow has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 38 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughUpdated documentation in the solvers tutorials: marked from_shadow_to_prod as draft, adjusted sidebar ordering for onboard/local_test/routes_integration, and added Telegram note, bonding-pool clarification, and a supported-networks list in the onboard guide. Changes
Sequence Diagram(s)(No sequence diagrams: changes are documentation/front-matter edits only.) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/cow-protocol/tutorials/solvers/from_shadow_to_prod.md(2 hunks)docs/cow-protocol/tutorials/solvers/onboard.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/tutorials/solvers/onboard.md
[style] ~6-~6: Consider a more concise word here.
Context: ...otocol Solver Competition > NOTE: In order to get connected to the shadow competition...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
docs/cow-protocol/tutorials/solvers/onboard.md
7-7: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🔇 Additional comments (3)
docs/cow-protocol/tutorials/solvers/from_shadow_to_prod.md (1)
3-3: Draft marking is appropriate.Marking this shadow-to-production tutorial as draft aligns with ongoing development and allows readers to understand this is guidance under refinement.
docs/cow-protocol/tutorials/solvers/onboard.md (2)
2-2: Sidebar reordering elevates the onboarding guide appropriately.Moving
sidebar_positionfrom 5 to 1 makes this foundational guide the first in the solvers tutorial sequence, which is contextually correct for solver onboarding.
45-49: Network support transparency is helpful.The addition of the supported networks list at line 48 clearly communicates availability and sets expectations for solvers. The list is informative and well-placed in the Exposed Endpoint section.
| > **_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. | ||
| > **_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. |
There was a problem hiding this comment.
Fix blockquote formatting and simplify phrase.
Line 7 creates a blank line inside the blockquote, which violates markdown block integrity (MD028). Additionally, "In order to" at line 6 can be simplified to "To" for conciseness.
Apply this diff to fix the formatting and improve clarity:
# Joining The CoW Protocol Solver Competition
- > **_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.
-
+ > **_NOTE:_** 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.
> **_NOTE:_** Most of this document assumes that you will be joining the solver competition under the CoW DAO bonding pool...📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > **_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. | |
| > **_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. | |
| > **_NOTE:_** 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. | |
| > **_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. |
🧰 Tools
🪛 LanguageTool
[style] ~6-~6: Consider a more concise word here.
Context: ...otocol Solver Competition > NOTE: In order to get connected to the shadow competition...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
7-7: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for AI Agents
In docs/cow-protocol/tutorials/solvers/onboard.md around lines 6 to 8, the
blockquote contains a blank line that breaks markdown block integrity and the
phrase "In order to" is verbose; remove the empty line between the two NOTE
paragraphs so the blockquote remains continuous and replace "In order to get
connected to the shadow competition" with "To get connected to the shadow
competition" to simplify the wording.
Updated the reference to API specification and schema.
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.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.