Improve dub-partners help doc#307
Conversation
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughReorders Help Center navigation, restructures the Dub Partners guide with embedded media and new sections (fraud, payouts, tax, landing forms), refactors partner-rewards content into staggered-duration examples and tables, and makes small edits to fraud-detection and program-analytics content and metrics. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
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)
📝 Coding Plan
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: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
help/article/dub-partners.mdx (1)
272-277:⚠️ Potential issue | 🟡 MinorFix the typo in the related-article card.
wihinshould bewithin.✏️ Suggested fix
- Enroll partners directly from wihin your app + Enroll partners directly from within your app🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@help/article/dub-partners.mdx` around lines 272 - 277, In the Card component rendering the related article (the block with title="Embedded referral dashboard", icon="grid-2", href="/docs/partners/embedded-referrals"), fix the typo in the card body by changing "wihin" to "within" so the copy reads "Enroll partners directly from within your app".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@help/article/dub-partners.mdx`:
- Line 165: Edit the sentence in the Dub Partners copy that currently reads
“whether if they're signing up via a [referral link]…” to remove the extra “if”
so it reads either “whether they’re signing up via a [referral link]…” or “if
they’re signing up via a [referral link]…”, keeping the rest of the links and
punctuation unchanged.
- Around line 69-73: The img element in the MDX snippet currently has
alt="Time-series chart" which is incorrect for the funnel screenshot; update the
<img> tag's alt attribute to an accurate, concise description such as "Funnel
analytics view showing conversion stages and drop-offs" (or similar accessible
text) so screen readers correctly describe the asset.
- Line 76: Update the relative docs link in the sentence containing "install in
just a few clicks" so it uses an absolute path; change the href from
"docs/integrations/stripe" to "/docs/integrations/stripe" in the link inside
help/article/dub-partners.mdx to ensure the URL resolves to /docs/... rather
than under /help/article/....
In `@help/article/partner-rewards.mdx`:
- Around line 260-263: Update the link target for the metadata prop so it points
at the canonical documentation route; replace the current href
"/docs/api-reference/endpoint/track-sale" with "/docs/api-reference/track/sale"
in the sentence that references `/track/sale` and the [metadata prop] link so
the product ID example (metadata.productId) links to the correct canonical page.
- Line 241: The table row contains a missing space in the condition token:
change the string "`If`Sale` `Product ID` `is` `prod_xxx` | Then pay a
`Percentage` of `40%` per sale | Higher reward for `prod_xxx` sales`" so that
the backticked tokens are separated (e.g. "`If` `Sale` `Product ID` `is`
`prod_xxx` | Then pay a `Percentage` of `40%` per sale | Higher reward for
`prod_xxx` sales`") to ensure `If` and `Sale` render separately and the
condition is easier to scan.
In `@help/article/program-analytics.mdx`:
- Line 12: The sentence "On any given day, Dub tracks upwards of **10 million
clicks, [conversion](/help/article/dub-conversions), and
[commission](/help/article/partner-commissions) events.**" is not parallel;
change it to a parallel construction such as "On any given day, Dub tracks
upwards of **10 million events across clicks, conversions, and commissions.**"
Update the text in program-analytics.mdx replacing the original phrase so the
numeric count clearly applies to all three event types and keep the existing
links for conversions and commissions.
---
Outside diff comments:
In `@help/article/dub-partners.mdx`:
- Around line 272-277: In the Card component rendering the related article (the
block with title="Embedded referral dashboard", icon="grid-2",
href="/docs/partners/embedded-referrals"), fix the typo in the card body by
changing "wihin" to "within" so the copy reads "Enroll partners directly from
within your app".
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 308b3ead-de8c-44a2-96d6-0f5da8564da4
📒 Files selected for processing (5)
docs.jsonhelp/article/dub-partners.mdxhelp/article/fraud-detection.mdxhelp/article/partner-rewards.mdxhelp/article/program-analytics.mdx
💤 Files with no reviewable changes (1)
- help/article/fraud-detection.mdx
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit