Update KYC steps in onboarding documentation#600
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughDocumentation restructure for solver onboarding KYC requirements, converting narrative text into a structured bullet-point list with explicit document requirements and processing timeline. 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)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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`:
- Around line 30-33: Revise the ambiguous passport requirement sentence ("one or
two passports of the main shareholders and developers") to explicitly list whose
passports are required—e.g., "one or two passport copies for each main
shareholder and for each core developer listed on the solver team"—so teams know
to include passports for every named main shareholder and every listed
developer; also update the following sentence to US English by changing "Do not
send this before the meeting, we will explain the process during the meeting so
that you can send the documents afterwards" to "Do not send these before the
meeting; we will explain the process during the meeting so that you can send the
documents afterward."
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ea0fc3a4-9490-482d-b36b-343815744d27
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/solvers/onboard.md
| - Incorporation details of the company behind the solver that includes details of who the shareholders are | ||
| - One or two passports of the main shareholders and developers of the solver | ||
|
|
||
| Do not send this before the meeting, we will explain the process during the meeting so that you can send the documents afterwards. We usually expect the KYC process to take about 1 to 3 working days, but it may vary. |
There was a problem hiding this comment.
Clarify which people’s passports are required.
Line 31 is still ambiguous about scope: “one or two passports of the main shareholders and developers” can mean one or two passports total, or passports for whichever people CoW considers “main.” Please spell out exactly whose documents are needed; otherwise teams can show up with the wrong KYC packet. While touching this, Line 33 should read “Do not send these before the meeting … afterward” for agreement and consistent US English.
🧰 Tools
🪛 LanguageTool
[locale-violation] ~33-~33: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ting so that you can send the documents afterwards. We usually expect the KYC process to t...
(AFTERWARDS_US)
🤖 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` around lines 30 - 33, Revise
the ambiguous passport requirement sentence ("one or two passports of the main
shareholders and developers") to explicitly list whose passports are
required—e.g., "one or two passport copies for each main shareholder and for
each core developer listed on the solver team"—so teams know to include
passports for every named main shareholder and every listed developer; also
update the following sentence to US English by changing "Do not send this before
the meeting, we will explain the process during the meeting so that you can send
the documents afterwards" to "Do not send these before the meeting; we will
explain the process during the meeting so that you can send the documents
afterward."
Description
This PR updates the KYC section of the solver on-boarding guide to provide a more detailed description of the process.
Changes
Updated https://docs.cow.fi/cow-protocol/tutorials/solvers/onboard#requirements-for-joining-the-cow-dao-bonding-pool
Summary by CodeRabbit