Skip to content

Improve dub-partners help doc#307

Merged
steven-tey merged 5 commits into
mainfrom
improve-dub-partners
Mar 17, 2026
Merged

Improve dub-partners help doc#307
steven-tey merged 5 commits into
mainfrom
improve-dub-partners

Conversation

@steven-tey
Copy link
Copy Markdown
Contributor

@steven-tey steven-tey commented Mar 17, 2026

Summary by CodeRabbit

  • Documentation
    • Redesigned Dub Partners guide with a multimedia platform tour, new feature sections (social-metrics bounties, fraud detection, global payouts, tax compliance), richer media and restructured content.
    • Restructured Help Center article order for improved discovery.
    • Reworked partner rewards docs with clearer, example-driven reward conditions and staggered-duration tables.
    • Updated program analytics metric (daily clicks increased).

@steven-tey
Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 17, 2026

✅ Actions performed

Full review triggered.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 17, 2026

Warning

Rate limit exceeded

@steven-tey has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ab936139-4d17-46f1-8d45-a44c3f4ccc20

📥 Commits

Reviewing files that changed from the base of the PR and between 1458ac7 and 405bf0d.

📒 Files selected for processing (3)
  • help/article/dub-partners.mdx
  • help/article/partner-rewards.mdx
  • help/article/program-analytics.mdx
📝 Walkthrough

Walkthrough

Reorders 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

Cohort / File(s) Summary
Documentation Navigation
docs.json
Reordered pages in Help Center groups: moved help/article/how-to-set-up-bank-account after help/article/partner-payouts; added help/article/program-bounties at start of "Engaging partners"; repositioned help/article/messaging-partners and removed a duplicate entry.
Dub Partners guide
help/article/dub-partners.mdx
Major content restructure: broadened description, replaced linear feature list with embedded platform tour iframe, added media-rich sections (social bounties, embedded dashboard, landing pages), introduced tax/payout/two-sided incentives and fraud-detection content, and reorganized Related Articles layout.
Partner rewards
help/article/partner-rewards.mdx
Replaced simple reward-condition bullets with linked titled sections and a new staggered-duration focus; added a 3-condition table for durations, updated visuals, tips, and product-ID metadata notes.
Minor docs edits & metrics
help/article/fraud-detection.mdx, help/article/program-analytics.mdx
Removed the "Using fraud detection" heading/intro from fraud-detection; updated program analytics daily clicks metric from 5 million to 10 million.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

Poem

🐰 I hopped through docs and nudged the trail,
Pages reordered, a bright new tale.
Tours and bounties sparkle in sight,
Rewards re-tabled, metrics take flight—
Hop in, friend, the updates are right! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly aligns with the primary changes in the PR, which center on extensive updates and improvements to the dub-partners help documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch improve-dub-partners
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟡 Minor

Fix the typo in the related-article card.

wihin should be within.

✏️ 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

📥 Commits

Reviewing files that changed from the base of the PR and between 504361e and 1458ac7.

📒 Files selected for processing (5)
  • docs.json
  • help/article/dub-partners.mdx
  • help/article/fraud-detection.mdx
  • help/article/partner-rewards.mdx
  • help/article/program-analytics.mdx
💤 Files with no reviewable changes (1)
  • help/article/fraud-detection.mdx

Comment thread help/article/dub-partners.mdx
Comment thread help/article/dub-partners.mdx Outdated
Comment thread help/article/dub-partners.mdx Outdated
Comment thread help/article/partner-rewards.mdx Outdated
Comment thread help/article/partner-rewards.mdx
Comment thread help/article/program-analytics.mdx Outdated
steven-tey and others added 4 commits March 16, 2026 22:58
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>
@steven-tey steven-tey merged commit c283e84 into main Mar 17, 2026
2 checks passed
@steven-tey steven-tey deleted the improve-dub-partners branch March 17, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant