docs: add advocate welcome kit and update SDK quickstart #134
Conversation
WalkthroughAdds an Advocates Welcome Kit doc and navigation/FAQ entries; replaces placeholder content with concrete "Update a request" examples in the Node.js quickstart and expands the Request Client "Updating a request" guide with an actions table and usage examples. All edits are documentation-only. Changes
Sequence Diagram(s)(omitted — changes are documentation updates and do not introduce new executable control flow requiring a sequence diagram) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
|
Hello @AllenAJ, thank you for submitting your first pull request to the docs.request.network repository. We value your contribution and encourage you to review our contribution guidelines to ensure your submission meets our standards. Please note that every merged PR is automatically enrolled in our Best PR Initiative, offering a chance to win $500 each quarter. Our team is available via GitHub Discussions or Discord if you have any questions. Welcome aboard! |
|
Thank you for your submission! As you prepare for the review process, please ensure that your PR title, description, and any linked issues fully comply with our contribution guidelines. A clear explanation of your changes and their context will help expedite the review process. Every merged PR is automatically entered into our Best PR Initiative, offering a chance to win $500 every quarter. We appreciate your attention to detail and look forward to reviewing your contribution! |
Greptile SummaryThis PR enhances the documentation by adding an Advocates Welcome Kit for community onboarding and completing the "Updating a Request" guide with working code examples. The Node.js quickstart now includes a request update section and viem integration example. Key Changes:
Issues Found:
Confidence Score: 3/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User as Developer/Advocate
participant Docs as Documentation
participant SDK as Request Network SDK
participant Node as Request Node
participant IPFS as IPFS Network
Note over User,Docs: New Advocate Onboarding Flow
User->>Docs: Access Advocates Welcome Kit
Docs-->>User: Program details, tools, rewards
Note over User,SDK: Request Update Workflow
User->>SDK: Initialize RequestNetwork client<br/>with signatureProvider
User->>SDK: fromRequestId(requestId)
SDK->>Node: Fetch request data
Node->>IPFS: Retrieve request content
IPFS-->>Node: Request data
Node-->>SDK: Request object
SDK-->>User: Request instance
User->>SDK: request.accept(signerIdentity)
SDK->>SDK: Sign update with private key
SDK->>Node: Submit update transaction
Node->>IPFS: Store update
Node->>Blockchain: Store CID hash
SDK-->>User: Updated request data
User->>SDK: request.waitForConfirmation()
SDK->>Node: Poll for confirmation
Node-->>SDK: Confirmed
SDK-->>User: Confirmed request data
Note over User,SDK: Payment Flow (with viem)
User->>SDK: Create viem clients
User->>SDK: Convert to ethers v5 signer
SDK->>SDK: Check funds & approval
User->>SDK: payRequest(requestData, signer)
SDK->>Blockchain: Execute payment transaction
Blockchain-->>SDK: Transaction receipt
SDK-->>User: Payment complete
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Additional Comments (4)
-
docs/advanced/request-network-sdk/get-started/quickstart-node.js.md, line 197-200 (link)logic: Uses
mainnetchain but the rest of the quickstart uses Sepolia. Should be consistent.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
-
docs/advanced/request-network-sdk/get-started/quickstart-node.js.md, line 205-207 (link)logic: Chain should match Sepolia for consistency with the rest of the quickstart.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
-
docs/advanced/request-network-sdk/get-started/quickstart-node.js.md, line 211-213 (link)logic: Should use
sepoliainstead ofmainnetfor consistency.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
-
docs/advanced/request-network-sdk/get-started/quickstart-node.js.md, line 210-214 (link)logic: The viem
WalletClient.transportis not directly compatible with ethersWeb3Provider. Check the implementation inquickstart-browser.md:274-284which properly extracts account and chain info from thewalletClientbefore creating the provider.
5 files reviewed, 4 comments
![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: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/SUMMARY.mddocs/advanced/request-network-sdk/get-started/quickstart-node.js.mddocs/advanced/request-network-sdk/sdk-guides/request-client/updating-a-request.mddocs/faq.mddocs/general/advocates-welcome-kit.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: - Only comment on issues that would block merging — ignore minor or stylistic concerns.
- Restrict feedback to errors, security risks, or functionality-breaking problems.
- Do not post comments on code style, formatting, or non-critical improvements.
- Keep reviews short: flag only issues that make the PR unsafe to merge.
- Limit review comments to 3–5 items maximum, unless additional blockers exist.
- Group similar issues into a single comment instead of posting multiple notes.
- Skip repetition — if a pattern repeats, mention it once at a summary level only.
- Do not add general suggestions; focus strictly on merge-blocking concerns.
- If there are no critical problems, respond with minimal approval (e.g., 'Looks good'). Do not add additional review.
- Avoid line-by-line commentary unless it highlights a critical bug or security hole.
- Highlight only issues that could cause runtime errors, data loss, or severe maintainability issues.
- Ignore minor optimization opportunities — focus solely on correctness and safety.
- Provide a top-level summary of critical blockers rather than detailed per-line notes.
- Comment only when the issue must be resolved before merge — otherwise, remain silent.
- When in doubt, err on the side of fewer comments — brevity and blocking issues only.
- Avoid posting any refactoring issues
Files:
docs/advanced/request-network-sdk/get-started/quickstart-node.js.mddocs/general/advocates-welcome-kit.mddocs/SUMMARY.mddocs/faq.mddocs/advanced/request-network-sdk/sdk-guides/request-client/updating-a-request.md
🪛 LanguageTool
docs/general/advocates-welcome-kit.md
[style] ~20-~20: The noun “invitation” is usually used instead of ‘invite’ in formal writing.
Context: ...ols * Notion: You will receive an invite to our private Advocates workspace. * ...
(AN_INVITE)
🪛 markdownlint-cli2 (0.18.1)
docs/general/advocates-welcome-kit.md
47-47: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Greptile Review
docs/advanced/request-network-sdk/get-started/quickstart-node.js.md
Outdated
Show resolved
Hide resolved
|
Regarding the Greptile feedback about | **addStakeholders** | Grant 1 or more third parties access to view an encrypted request | Payee, Payer, or Third Party |We'll add this back in a follow-up commit. |
- Replace broken viem-to-ethers code in Node.js quickstart with note explaining that viem http() transport isn't EIP-1193 compatible - Restore addStakeholders row to updating-a-request.md table Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
I've pushed a fix commit (087dc01) to your branch that:
The rest of the PR looks good - the Advocates Welcome Kit and the Update a Request examples are helpful additions. Thanks for the contribution! |
Change Discord link from discord.gg/request to request.network/discord to match existing docs pattern. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.