|
| 1 | +# PR #134 Code Review - Advocate Welcome Kit and SDK Docs Update - 2026-01-21 |
| 2 | + |
| 3 | +## PR Summary |
| 4 | +- **Title**: docs: add advocate welcome kit and update SDK quickstart |
| 5 | +- **Author**: AllenAJ |
| 6 | +- **Description**: Added an Advocates Welcome Kit for community onboarding, enhanced the "Updating a Request" guide with functional code examples, updated the Node.js Quickstart with viem integration and request update logic, and updated FAQ and navigation. |
| 7 | + |
| 8 | +## File Groups |
| 9 | + |
| 10 | +### Group 1: SDK Documentation (Code Examples) - High Priority |
| 11 | +- [ ] `docs/advanced/request-network-sdk/get-started/quickstart-node.js.md` |
| 12 | +- [ ] `docs/advanced/request-network-sdk/sdk-guides/request-client/updating-a-request.md` |
| 13 | +**Status**: Not Started |
| 14 | + |
| 15 | +### Group 2: Advocate Program Documentation - Medium Priority |
| 16 | +- [ ] `docs/general/advocates-welcome-kit.md` |
| 17 | +**Status**: Not Started |
| 18 | + |
| 19 | +### Group 3: Navigation Updates - Low Priority |
| 20 | +- [ ] `docs/SUMMARY.md` |
| 21 | +- [ ] `docs/faq.md` |
| 22 | +**Status**: Not Started |
| 23 | + |
| 24 | +## Review Updates |
| 25 | +- **2026-01-21 21:55 UTC**: Posted reply comments for issues #2 and #4 |
| 26 | +- **2026-01-21 21:56 UTC**: Pushed fix commit (087dc01) to contributor's branch - replaced viem tab with note, restored addStakeholders row |
| 27 | +- **2026-01-21 22:00 UTC**: Pushed fix commit (26bd317) - changed Discord link to use consistent format (request.network/discord) |
| 28 | + |
| 29 | +## Issues Identified |
| 30 | + |
| 31 | +| Index | File | Issue | Severity | Source | Comment Status | Validation | Resolution | Comment | |
| 32 | +|-------|------|-------|----------|--------|----------------|------------|------------|---------| |
| 33 | +| 1 | quickstart-node.js.md | Viem integration uses `mainnet` chain instead of `sepolia` (inconsistent with rest of quickstart) | High | Greptile | POSTED | VALID | FIXED | Covered by #2 fix - replaced viem tab entirely | |
| 34 | +| 2 | quickstart-node.js.md | Viem `http()` transport is NOT EIP-1193 compatible - Web3Provider conversion will fail at runtime | Critical | CodeRabbit | POSTED | VALID | FIXED | Replaced viem tab with note pointing to ethers v5 | |
| 35 | +| 3 | quickstart-node.js.md | Viem-to-ethers conversion pattern differs from browser quickstart's working implementation | High | Greptile | POSTED | VALID | FIXED | Same as #2 | |
| 36 | +| 4 | updating-a-request.md | Missing `addStakeholders` action from the summary table (was in original) | Low | Greptile | POSTED | VALID | FIXED | Added addStakeholders row back to table | |
| 37 | + |
| 38 | +## Review Progress |
| 39 | + |
| 40 | +### Group 1: SDK Documentation (Code Examples) - Not Started |
| 41 | +**General Description**: TBD |
| 42 | + |
| 43 | +**Files**: quickstart-node.js.md, updating-a-request.md |
| 44 | + |
| 45 | +**Issues Found**: See Issues Identified table (indices 1, 2, 3, 4) |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +### Group 2: Advocate Program Documentation - Not Started |
| 50 | +**General Description**: TBD |
| 51 | + |
| 52 | +**Files**: advocates-welcome-kit.md |
| 53 | + |
| 54 | +**Issues Found**: None identified yet |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +### Group 3: Navigation Updates - Not Started |
| 59 | +**General Description**: TBD |
| 60 | + |
| 61 | +**Files**: SUMMARY.md, faq.md |
| 62 | + |
| 63 | +**Issues Found**: None identified yet |
| 64 | + |
| 65 | +--- |
0 commit comments