Update KYC steps in onboarding documentation#600
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughReplaced a single-sentence KYC note with a structured checklist that requests company incorporation/shareholder details, one–two passports for main shareholders and developers, requires the solver name in the email, retains “do not send before the meeting,” and adds a 1–3 working day processing estimate. 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: 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."
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/cow-protocol/tutorials/solvers/onboard.md (1)
31-34:⚠️ Potential issue | 🟡 MinorClarify passport scope and tighten the instruction sentence.
Line 31 is still ambiguous about whether “one or two passports” is total or required per person.
Also, Line 34 should use plural agreement and US-English “afterward” for consistency.Suggested wording
-- One or two passports of the main shareholders and developers of the solver +- One or two passport copies for each main shareholder and each core developer of the solver team -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. +Do not send these before the meeting; we will explain the process during the meeting so that you can send the documents afterward. We usually expect the KYC process to take about 1 to 3 working days, but it may vary.🤖 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 31 - 34, Clarify the ambiguous passport requirement and tighten the follow-up sentence: replace the phrase "One or two passports of the main shareholders and developers of the solver" with an explicit scope such as "Provide passport copies for the main shareholders and developers — one passport copy per person (up to two individuals)." Also split and pluralize the later sentence and use 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 two sentences like "Do not send these documents before the meeting. We will explain the process during the meeting so you can send the documents afterward." Ensure both replacements appear where the original phrases occur.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/cow-protocol/tutorials/solvers/onboard.md`:
- Around line 31-34: Clarify the ambiguous passport requirement and tighten the
follow-up sentence: replace the phrase "One or two passports of the main
shareholders and developers of the solver" with an explicit scope such as
"Provide passport copies for the main shareholders and developers — one passport
copy per person (up to two individuals)." Also split and pluralize the later
sentence and use 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 two sentences like "Do not send these documents before the
meeting. We will explain the process during the meeting so you can send the
documents afterward." Ensure both replacements appear where the original phrases
occur.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5fc4c962-b824-4bc5-8328-35ffbdf0ccc7
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/solvers/onboard.md
Co-authored-by: Haris Angelidakis <64154020+harisang@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/cow-protocol/tutorials/solvers/onboard.md (2)
34-34:⚠️ Potential issue | 🟡 MinorFix pronoun agreement and dialect preference.
This sentence has issues previously identified: (1) "this" should be "these" to agree with "documents," and (2) "afterwards" should be "afterward" for US English consistency.
📝 Proposed fix
-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. +Do not send these before the meeting; we will explain the process during the meeting so that you can send the documents afterward. We usually expect the KYC process to take about 1 to 3 working days, but it may vary.🤖 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 34, Update the sentence "Do not send this before the meeting, we will explain the process during the meeting so that you can send the documents afterwards." to use correct plural and US English: change "this" to "these" to agree with "documents" and change "afterwards" to "afterward"; the resulting sentence should read something like "Do not send these before the meeting, we will explain the process during the meeting so that you can send the documents afterward."
31-31:⚠️ Potential issue | 🟡 MinorClarify the passport requirement scope.
The phrasing "one or two passports of the main shareholders and developers" remains ambiguous—it's unclear whether this means 1-2 passports total or 1-2 passport copies per person. Teams may submit incomplete KYC packets without explicit guidance.
✏️ Suggested clarification
-- One or two passports of the main shareholders and developers of the solver. +- One or two passport copies for each main shareholder and for each core developer of the solver.🤖 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 31, Replace the ambiguous phrase "One or two passports of the main shareholders and developers of the solver." with a clear, prescriptive sentence such as "Provide 1–2 passport copies per identified individual (i.e., for each main shareholder and each developer), showing full name, photo and expiry date; scanned color copies are acceptable and specify if notarized or certified copies are required." Update the line containing the original quoted text to this clarified wording so reviewers know whether the count is per person and what document quality/verification is expected.
🤖 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 30: The sentence "Incorporation details of the company behind the solver
that includes details of who the shareholders are." has a subject-verb agreement
error: change the verb "includes" to the plural form "include" so it reads
"Incorporation details of the company behind the solver that include details of
who the shareholders are."
---
Duplicate comments:
In `@docs/cow-protocol/tutorials/solvers/onboard.md`:
- Line 34: Update the sentence "Do not send this before the meeting, we will
explain the process during the meeting so that you can send the documents
afterwards." to use correct plural and US English: change "this" to "these" to
agree with "documents" and change "afterwards" to "afterward"; the resulting
sentence should read something like "Do not send these before the meeting, we
will explain the process during the meeting so that you can send the documents
afterward."
- Line 31: Replace the ambiguous phrase "One or two passports of the main
shareholders and developers of the solver." with a clear, prescriptive sentence
such as "Provide 1–2 passport copies per identified individual (i.e., for each
main shareholder and each developer), showing full name, photo and expiry date;
scanned color copies are acceptable and specify if notarized or certified copies
are required." Update the line containing the original quoted text to this
clarified wording so reviewers know whether the count is per person and what
document quality/verification is expected.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 51a4a247-6b15-4c96-8bb4-cca4f08d194f
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/solvers/onboard.md
| The general KYC requirements are to send us documentation proving that you are the beneficial owners of the company behind the solver and 1-2 passports of some of the main 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. | ||
| The general KYC requirements are as follows: | ||
|
|
||
| - Incorporation details of the company behind the solver that includes details of who the shareholders are. |
There was a problem hiding this comment.
Fix subject-verb agreement.
The plural subject "details" requires the plural verb "include" rather than "includes."
📝 Proposed fix
-- Incorporation details of the company behind the solver that includes details of who the shareholders are.
+- Incorporation details of the company behind the solver that include details of who the shareholders are.📝 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.
| - Incorporation details of the company behind the solver that includes details of who the shareholders are. | |
| - Incorporation details of the company behind the solver that include details of who the shareholders are. |
🤖 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 30, The sentence
"Incorporation details of the company behind the solver that includes details of
who the shareholders are." has a subject-verb agreement error: change the verb
"includes" to the plural form "include" so it reads "Incorporation details of
the company behind the solver that include details of who the shareholders are."
4 participants
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