New vs recurring sale example - #373
Conversation
📝 WalkthroughWalkthroughThis PR adds documentation explaining how to configure reward conditions to distinguish first/new sales from recurring sales in the partner rewards system. The new section includes an example conditions table and visual guidance. ChangesPartner Rewards Documentation Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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 |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@help/article/partner-rewards.mdx`:
- Line 332: Rewrite the awkward sentence "This is especially useful for
subscription-based products, where you may want to offer a higher reward for the
first sale to incentivize partners to acquire new customers, while offering a
lower reward for recurring sales, while combining with other conditions." to
remove the repeated "while" and clarify the ending; for example, simplify to one
clear sentence that contrasts first-sale vs recurring rewards and notes that
these tiers can be combined with other conditions (e.g., "For subscription-based
products, offer a higher reward for the first sale to incentivize partner
acquisition and a lower reward for recurring sales; these tiers can be combined
with other conditions.").
- Line 323: The example description contains incorrect article usage ("a 80%
reward"); update the sentence in partner-rewards.mdx so it reads "an 80% reward"
instead of "a 80% reward" in the line that currently starts "In this example,
we're rewarding partners with a 80% reward for the first sale..."; ensure only
the article is changed and the rest of the sentence remains unchanged.
🪄 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: e648ada3-6487-43dc-838c-52cc9c0fd415
⛔ Files ignored due to path filters (2)
images/dub-partners/reward-example-firstsale-selected.pngis excluded by!**/*.pngimages/dub-partners/reward-example-firstsale.pngis excluded by!**/*.png
📒 Files selected for processing (1)
help/article/partner-rewards.mdx
| /> | ||
| </Frame> | ||
|
|
||
| In this example, we're rewarding partners with a 80% reward for the first sale while keeping the standard recurring commission for all other sales: |
There was a problem hiding this comment.
Fix article usage in the example description.
The phrase "a 80% reward" should use "an" instead of "a" since "80" starts with a vowel sound (eighty).
📝 Proposed fix
-In this example, we're rewarding partners with a 80% reward for the first sale while keeping the standard recurring commission for all other sales:
+In this example, we're rewarding partners with an 80% reward for the first sale while keeping the standard recurring commission for all other sales:📝 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.
| In this example, we're rewarding partners with a 80% reward for the first sale while keeping the standard recurring commission for all other sales: | |
| In this example, we're rewarding partners with an 80% reward for the first sale while keeping the standard recurring commission for all other sales: |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@help/article/partner-rewards.mdx` at line 323, The example description
contains incorrect article usage ("a 80% reward"); update the sentence in
partner-rewards.mdx so it reads "an 80% reward" instead of "a 80% reward" in the
line that currently starts "In this example, we're rewarding partners with a 80%
reward for the first sale..."; ensure only the article is changed and the rest
of the sentence remains unchanged.
| /> | ||
| </Frame> | ||
|
|
||
| This is especially useful for subscription-based products, where you may want to offer a higher reward for the first sale to incentivize partners to acquire new customers, while offering a lower reward for recurring sales, while combining with other conditions. |
There was a problem hiding this comment.
Simplify the sentence structure.
The sentence contains awkward phrasing with "while...while" repetition and an unclear ending phrase. The meaning would be clearer with simplified structure.
✏️ Proposed fix
-This is especially useful for subscription-based products, where you may want to offer a higher reward for the first sale to incentivize partners to acquire new customers, while offering a lower reward for recurring sales, while combining with other conditions.
+This is especially useful for subscription-based products, where you may want to offer a higher reward for the first sale to incentivize partners to acquire new customers, while offering a lower reward for recurring sales. You can also combine this with other conditions to create more complex reward structures.📝 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.
| This is especially useful for subscription-based products, where you may want to offer a higher reward for the first sale to incentivize partners to acquire new customers, while offering a lower reward for recurring sales, while combining with other conditions. | |
| This is especially useful for subscription-based products, where you may want to offer a higher reward for the first sale to incentivize partners to acquire new customers, while offering a lower reward for recurring sales. You can also combine this with other conditions to create more complex reward structures. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@help/article/partner-rewards.mdx` at line 332, Rewrite the awkward sentence
"This is especially useful for subscription-based products, where you may want
to offer a higher reward for the first sale to incentivize partners to acquire
new customers, while offering a lower reward for recurring sales, while
combining with other conditions." to remove the repeated "while" and clarify the
ending; for example, simplify to one clear sentence that contrasts first-sale vs
recurring rewards and notes that these tiers can be combined with other
conditions (e.g., "For subscription-based products, offer a higher reward for
the first sale to incentivize partner acquisition and a lower reward for
recurring sales; these tiers can be combined with other conditions.").
2 participants
Summary by CodeRabbit