Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughUpdated the solver onboarding documentation with formatting refinements including improved spacing before headings, inline link formatting for API specification reference, and adjustment of the staging volume link endpoint from barn.cow.fi to dev.cow.fi. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/cow-protocol/tutorials/solvers/onboard.md`:
- Line 143: Fix the typo in the sentence "An endpoint that you would like to use
for staging amd production." by replacing "amd" with "and" so it reads "An
endpoint that you would like to use for staging and production." Locate this
line in docs/cow-protocol/tutorials/solvers/onboard.md (the sentence text above)
and update the wording accordingly.
- Line 124: Replace the staging swap interface URL that currently points to
"https://dev.cow.fi" with the barn staging domain "https://barn.cow.fi" in the
onboarding doc; locate the occurrence of the dev.cow.fi link in the "onboard.md"
content (the line that instructs using the dev swap interface) and update the
hyperlink and any plain-text references to follow the barn.* naming convention
used elsewhere (e.g., barn.cow.fi).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 63c8b7fa-3d23-44bd-8659-05c81f740c7f
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/solvers/onboard.md
| After your solver is live and begins settling transactions, it will be your responsibility to monitor these addresses and to make sure that they hold enough funds to settle transactions for winning auctions. | ||
|
|
||
| In order to create some volume to test your solver, you can create orders on staging by using our barn swap interface ([https://barn.cow.fi](https://barn.cow.fi)). | ||
| In order to create some volume to test your solver, you can create orders on staging by using our dev swap interface ([https://dev.cow.fi](https://dev.cow.fi)). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Find all barn subdomain references in documentation
# Search for barn.cow.fi and barn.api.cow.fi references
echo "=== References to barn.cow.fi ==="
rg -n "barn\.cow\.fi" docs/
echo -e "\n=== References to barn.api.cow.fi ==="
rg -n "barn\.api\.cow\.fi" docs/Repository: cowprotocol/docs
Length of output: 2417
🏁 Script executed:
#!/bin/bash
# Check for references to dev.cow.fi
echo "=== References to dev.cow.fi ==="
rg -n "dev\.cow\.fi" docs/
# Get context around the onboard.md reference
echo -e "\n=== Context around onboard.md line 124 ==="
sed -n '120,130p' docs/cow-protocol/tutorials/solvers/onboard.md
# Get context around the local_test.md table
echo -e "\n=== Context around local_test.md table ==="
sed -n '45,75p' docs/cow-protocol/tutorials/solvers/local_test.mdRepository: cowprotocol/docs
Length of output: 3335
🏁 Script executed:
#!/bin/bash
# Check for references to staging environment across all docs
echo "=== References to 'staging' ==="
rg -n "staging" docs/cow-protocol/tutorials/solvers/ | head -20
# Check for 'barn' references with more context
echo -e "\n=== barn references with context ==="
rg -n "barn" docs/cow-protocol/tutorials/solvers/ -B 2 -A 2
# Check for other swap interface references
echo -e "\n=== Other references to swap interface ==="
rg -n "swap interface\|swap UI" docs/ -iRepository: cowprotocol/docs
Length of output: 10985
Update swap interface reference to match staging (barn) naming convention.
Line 124 uses dev.cow.fi for the staging swap interface, but this breaks the established naming convention used throughout the documentation. The staging environment is consistently referred to as "barn" elsewhere in this file (line 101: "staging (barn) competition") and across the solver documentation, where all staging endpoints use the barn.* subdomain pattern (barn.api.cow.fi, barn.gnosis-protocol.io, etc.).
Update dev.cow.fi to align with the barn naming convention for consistency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cow-protocol/tutorials/solvers/onboard.md` at line 124, Replace the
staging swap interface URL that currently points to "https://dev.cow.fi" with
the barn staging domain "https://barn.cow.fi" in the onboarding doc; locate the
occurrence of the dev.cow.fi link in the "onboard.md" content (the line that
instructs using the dev swap interface) and update the hyperlink and any
plain-text references to follow the barn.* naming convention used elsewhere
(e.g., barn.cow.fi).
There was a problem hiding this comment.
There's a backend staging env called barn (barn.api.cow.fi), and a frontend semi-stating env called barn (barn.cow.fi).
The frontend one is being removed, and instead the dev (dev.swap.cow.fi) should be used instead.
That's the point of this change.
There was a problem hiding this comment.
@alfetopito, thanks for the clarification! I misidentified the two distinct barn environments. The backend staging API (barn.api.cow.fi) is separate from the frontend swap interface (barn.cow.fi), and since the frontend one is being decommissioned in favour of dev.cow.fi, the change in this PR is correct. I'll withdraw my concern.
✏️ Learnings added
Learnt from: alfetopito
Repo: cowprotocol/docs PR: 606
File: docs/cow-protocol/tutorials/solvers/onboard.md:124-124
Timestamp: 2026-03-26T09:21:38.746Z
Learning: In the CoW Protocol docs (cowprotocol/docs), there are two distinct "barn" environments:
1. Backend staging API: `barn.api.cow.fi` — this continues to exist and should remain referenced as `barn`.
2. Frontend semi-staging swap interface: `barn.cow.fi` — this is being removed/decommissioned and replaced with `dev.cow.fi` (also known as `dev.swap.cow.fi`).
When reviewing docs that reference `barn.cow.fi` vs `dev.cow.fi`, do NOT flag replacement of `barn.cow.fi` → `dev.cow.fi` as inconsistent; it is intentional and correct.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
🧠 Learnings used
Learnt from: MarcusWentz
Repo: cowprotocol/docs PR: 586
File: docs/cow-protocol/tutorials/solvers/local_test.md:26-31
Timestamp: 2026-01-21T21:57:26.174Z
Learning: Document that the --native-price-estimators argument for the CoW Protocol autopilot CLI must use the Driver|name|url format (e.g., 'Driver|baseline|http://driver/baseline'), not just 'name|url'. Apply this guidance broadly in docs under the docs directory and include explicit examples to avoid ambiguity.
| After joining the solver competition on Arbitrum we can enable your solver on other chains relatively soon. For this we will go through the same process of generating addresses, vouching for them, and whitelisting them. For each new chain that we deploy your solver on we will need: | ||
|
|
||
| - A rewards address for receiving the weekly COW rewards associated with that network; | ||
| - An endpoint that you would like to use for staging amd production. |
There was a problem hiding this comment.
Fix typo: "amd" should be "and".
There's a spelling error in this line.
📝 Proposed fix
-- An endpoint that you would like to use for staging amd production.
+- An endpoint that you would like to use for staging and production.📝 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.
| - An endpoint that you would like to use for staging amd production. | |
| - An endpoint that you would like to use for staging and production. |
🧰 Tools
🪛 LanguageTool
[grammar] ~143-~143: Ensure spelling is correct
Context: ... that you would like to use for staging amd production. ## 9. Joining the mainnet ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cow-protocol/tutorials/solvers/onboard.md` at line 143, Fix the typo in
the sentence "An endpoint that you would like to use for staging amd
production." by replacing "amd" with "and" so it reads "An endpoint that you
would like to use for staging and production." Locate this line in
docs/cow-protocol/tutorials/solvers/onboard.md (the sentence text above) and
update the wording accordingly.
1 participant
Description
Replace barn.cow.fi references with dev.cow.fi
Changes
Summary by CodeRabbit