Skip to content

Submitted referrals#299

Open
marcusljf wants to merge 4 commits intomainfrom
submitted-referrals
Open

Submitted referrals#299
marcusljf wants to merge 4 commits intomainfrom
submitted-referrals

Conversation

@marcusljf
Copy link
Collaborator

@marcusljf marcusljf commented Mar 10, 2026

Help doc content for submitted referrals

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Help Center article on submitted referrals: how to review and manage submissions, plan prerequisites, differences from tracked leads, enabling lead/sale rewards, creating rewards, viewing submissions (table and drawer), status workflow and progression rules (New → Qualified → Meeting → Negotiation → Unqualified/Closed won/Closed lost), requirements for Closed won, UI examples, and notes on notifications and insights.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 10, 2026

Warning

Rate limit exceeded

@marcusljf has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 4 minutes and 25 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: 3c6f8e89-6a6f-48b4-80bc-4f46e8669c61

📥 Commits

Reviewing files that changed from the base of the PR and between ec2a1e7 and 9536262.

📒 Files selected for processing (1)
  • help/article/submitted-referrals.mdx
📝 Walkthrough

Walkthrough

Adds a new Help Center documentation page "submitted-referrals" and updates the docs navigation to include it under the Engaging partners group; the change is documentation-only.

Changes

Cohort / File(s) Summary
Documentation Navigation
docs.json
Inserted submitted-referrals into the Help Center "Engaging partners" pages list to expose the new article in site navigation.
Help Documentation
help/article/submitted-referrals.mdx
Added a new MDX article describing submitted referrals: prerequisites, differences vs tracked leads, reward creation, Partner Referrals table and referral drawer UX, status pipeline (New → Qualified → Meeting → Negotiation → Unqualified / Closed won / Closed lost), status-change rules, required fields for transitions, and UI screenshots.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • steven-tey

Poem

🐰 A page hops in with a curious beam,
Referral paths sketched like a nimble stream,
Statuses prance from New to Won,
Screens and tips gleam in the sun,
Hooray — documentation bounces with a dream! 🥕

🚥 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 'Submitted referrals' directly matches the main change: a new documentation page explaining submitted referrals functionality in Dub, added to docs.json navigation and implemented as a new help article.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch submitted-referrals

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.

@marcusljf marcusljf marked this pull request as ready for review March 10, 2026 16:47
Copy link
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.

🧹 Nitpick comments (1)
help/article/submitted-referrals.mdx (1)

108-124: Consider more descriptive alt text for accessibility.

The alt text on lines 111 and 122 both say "Submitted referrals drawer view" but these images show the specific Qualified and Closed won status dialogs respectively. More descriptive alt text would improve accessibility.

📝 Suggested alt text improvements
   <img
     src="/images/dub-partners/referral-status-qualified.png"
-    alt="Submitted referrals drawer view"
+    alt="Qualified status prompt with optional external ID field"
   />
   <img
     src="/images/dub-partners/referral-status-closedwon.png"
-    alt="Submitted referrals drawer view"
+    alt="Closed won status prompt with sale amount and Stripe customer ID fields"
   />
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@help/article/submitted-referrals.mdx` around lines 108 - 124, The alt text is
too generic; update the img alt attributes for the images with src
"referral-status-qualified.png" and "referral-status-closedwon.png" to be
specific and descriptive for accessibility—for example, replace "Submitted
referrals drawer view" for "referral-status-qualified.png" with something like
"Referral marked Qualified — drawer showing referral details and actions" and
replace the same generic alt for "referral-status-closedwon.png" with something
like "Referral Closed Won — prompt requesting required sale amount and optional
Stripe customer ID"; ensure the new alt strings clearly describe the visual
content and purpose.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@help/article/submitted-referrals.mdx`:
- Around line 108-124: The alt text is too generic; update the img alt
attributes for the images with src "referral-status-qualified.png" and
"referral-status-closedwon.png" to be specific and descriptive for
accessibility—for example, replace "Submitted referrals drawer view" for
"referral-status-qualified.png" with something like "Referral marked Qualified —
drawer showing referral details and actions" and replace the same generic alt
for "referral-status-closedwon.png" with something like "Referral Closed Won —
prompt requesting required sale amount and optional Stripe customer ID"; ensure
the new alt strings clearly describe the visual content and purpose.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b9e428eb-a48f-46b8-bd25-9b9d27d631e4

📥 Commits

Reviewing files that changed from the base of the PR and between 07da629 and f270c64.

⛔ Files ignored due to path filters (8)
  • images/dub-partners/create-lead-submitted-referral.png is excluded by !**/*.png
  • images/dub-partners/create-sale-submitted-referral.png is excluded by !**/*.png
  • images/dub-partners/customer-submitted-dash.png is excluded by !**/*.png
  • images/dub-partners/customer-submitted-tab.png is excluded by !**/*.png
  • images/dub-partners/referral-status-closedwon.png is excluded by !**/*.png
  • images/dub-partners/referral-status-qualified.png is excluded by !**/*.png
  • images/dub-partners/submitted-referral-drawer-save.png is excluded by !**/*.png
  • images/dub-partners/submitted-referral-drawer.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • docs.json
  • help/article/submitted-referrals.mdx

Copy link
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: 2

🤖 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/submitted-referrals.mdx`:
- Around line 108-125: Update the two image alt attributes so they are distinct
and descriptive: replace the alt on the image with src
"/images/dub-partners/referral-status-qualified.png" with text indicating the
"Qualified" state (e.g., "Submitted referrals drawer showing 'Qualified' status
and lead creation form"), and replace the alt on the image with src
"/images/dub-partners/referral-status-closedwon.png" with text describing the
"Closed won" state (e.g., "Submitted referrals drawer showing 'Closed won'
status with required sale amount and optional Stripe customer ID");
alternatively, if the surrounding copy fully conveys the content, mark an image
decorative by setting its alt to an empty string "" instead of a duplicate
generic description.
- Around line 43-46: The "Sale reward" section currently conflicts with the
later line about `Closed won` requiring an associated customer; update the
wording under the "Sale reward" heading to clearly state the actual behavior:
either that moving a referral to `Closed won` will create a customer record
automatically or that it requires an existing customer before it can be moved,
and then align the phrasing with the later line that mentions the referral must
have an associated customer; specifically, change the sentence "This will create
the customer record, and the partner will be rewarded." to a definitive
statement that uses the `Closed won` term (e.g., "Moving a referral to `Closed
won` will create the customer record and reward the partner." OR "The referral
must already have an associated customer before moving to `Closed won`; the
partner will be rewarded when the referral is set to `Closed won`.") so the
guidance in "Sale reward" and the later line about referrals are consistent.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: abe5500b-2ac5-490a-b8bf-5b22bfa70bfe

📥 Commits

Reviewing files that changed from the base of the PR and between f270c64 and ec2a1e7.

📒 Files selected for processing (1)
  • help/article/submitted-referrals.mdx

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