Update docs for dub partners + guides

[mcsdevv]

Summary by CodeRabbit

• Documentation
  • Added comprehensive guide library covering analytics, custom domains, API, partners, programs, SAML SSO, and workspace management.
  • Reorganized platform documentation structure and navigation.
  • Enhanced data model documentation with detailed entity relationships and visual diagrams.
  • Updated introduction and platform overview with improved feature descriptions.
  • Applied content consistency updates across documentation.

[coderabbitai]

Important

Review skipped

Too many files!

This PR contains 185 files, which is 35 over the limit of 150.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• ✅ Full review completed - (🔄 Check again to review again)

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (6)

conversions/leads/deferred.mdx (3)

114-114: ⚠️ Potential issue | 🔴 Critical

Fix inconsistent field naming in Go examples.

The field customerExternalId uses camelCase, which is inconsistent with the other fields (CustomerName, CustomerEmail, CustomerAvatar) that use PascalCase. In Go, exported struct fields should follow PascalCase naming conventions.

🐛 Proposed fix for consistent field naming

Line 114:

-        customerExternalId:      customer.ID,
+        CustomerExternalId:      customer.ID,

Line 237:

-    customerExternalId:      customer.ID,
+    CustomerExternalId:      customer.ID,

Also applies to: 237-237

---

172-172: ⚠️ Potential issue | 🔴 Critical

Fix typo in PHP field name.

The field name has a typo: customerNasme should be customerName.

🐛 Proposed fix for the typo

-    $request->customerNasme = $customer->name;
+    $request->customerName = $customer->name;

---

279-279: ⚠️ Potential issue | 🔴 Critical

Fix typo in PHP field name (duplicate issue).

The same typo appears here: customerNasme should be customerName.

🐛 Proposed fix for the typo

-    $request->customerNasme = $customer->name;
+    $request->customerName = $customer->name;

partners/link-based-discounts.mdx (2)

83-83: ⚠️ Potential issue | 🟡 Minor

Typo: Missing space in "todelete".

There's a missing space between "to" and "delete".

📝 Suggested fix

-Since Stripe doesn't support updating coupons after creation, you'd need todelete your discount in Dub and create a new one if you want to update any of the discount parameters.
+Since Stripe doesn't support updating coupons after creation, you'd need to delete your discount in Dub and create a new one if you want to update any of the discount parameters.

---

403-403: ⚠️ Potential issue | 🟡 Minor

Same typo repeated here.

This is a duplicate of the warning text from Option 1 with the same "todelete" typo.

📝 Suggested fix

-Since Stripe doesn't support updating coupons after creation, you'd need todelete your discount in Dub and create a new one if you want to update any of the discount parameters.
+Since Stripe doesn't support updating coupons after creation, you'd need to delete your discount in Dub and create a new one if you want to update any of the discount parameters.

README.md (1)

13-23: ⚠️ Potential issue | 🟡 Minor

Consider explicitly mentioning pnpm in the README setup steps.

The repository already declares pnpm@9.3.0 in the packageManager field of package.json, which automatically enforces pnpm when Corepack is enabled on Node.js 16.9+. However, explicitly mentioning this in the README would improve clarity for new contributors unfamiliar with the packageManager convention. A simple note before step 2 (e.g., "This project uses pnpm. Ensure pnpm is installed or enable Corepack.") would remove ambiguity without requiring additional setup steps.

🤖 Fix all issues with AI agents

In `@conversions/quickstart.mdx`:
- Around line 67-113: Update the two mobile SDK links in the "Dub also offers
Mobile SDKs" sentence so they use the mobile SDK path prefix; replace
"/sdks/client-side/swift" with "/sdks/client-side-mobile/swift" and
"/sdks/client-side/react-native" with "/sdks/client-side-mobile/react-native" in
the JSX/MDX block that renders the mobile SDK links (the line containing "Dub
also offers **Mobile SDKs**").

In `@guides/getting-started/how-to-import-csv.mdx`:
- Around line 1-6: The guide titled "How to Import a CSV" currently contains
only a migration notice and no actionable steps; replace or supplement the
placeholder with a complete how-to: add a clear step-by-step walkthrough
(prereqs, CSV format requirements, UI path or CLI commands to import, field
mapping examples, error handling/troubleshooting, and a short example CSV), or
remove the page from navigation until ready; locate the file by its frontmatter
title "How to Import a CSV" and update the body content accordingly to include
the full import instructions.

In `@guides/getting-started/introduction.mdx`:
- Line 48: Update the phrase "Device & geo targeting" in the introduction
content to use the hyphenated compound adjective: change it to "Device &
geo-targeting" so the modifier is grammatically correct.

In `@guides/programs/navigating-partner-program.mdx`:
- Around line 1-6: The file with frontmatter title "Navigating a Partner
Program" currently only contains a migration notice and no guide content; either
populate the document with the full migrated guide text under that title,
replace the placeholder link with the specific Help Center article URL for
"Navigating a Partner Program", or remove/hold the file until the migration is
complete to avoid publishing an empty stub—update the body below the frontmatter
(the content under the title and description) accordingly to implement one of
these options.

In `@guides/saml-sso/azure-scim.mdx`:
- Around line 1-6: The Azure SCIM guide (file guides/saml-sso/azure-scim.mdx,
frontmatter title "Azure SCIM") is incomplete; replace the migration-only
content with either the full migrated setup steps or at minimum add a direct
link to the original help-center article, a clear "Coming soon" placeholder with
an expected ETA, and a short summary of the key setup steps; specifically update
the body to include (1) a link such as [current
guide](https://dub.co/help/article/azure-scim), (2) a concise "Coming soon —
expected by <date>" placeholder if full content isn't ready, and (3) a TODO note
that the full migration should include the SCIM provisioning prerequisites,
Azure AD app configuration steps, SCIM attribute mappings, and
testing/verification steps so reviewers can see what's missing.

🧹 Nitpick comments (20)

guides/api/generate-qr-codes.mdx (1)

1-6: Consider hiding placeholder guides from navigation.

This file currently shows a migration notice without actual content. Users navigating to this guide will only see a placeholder message. Consider adding a hidden: true front matter field or deferring publication until the content migration is complete.

💡 Suggested front matter addition to hide until ready

 ---
 title: "Generate QR Codes"
 description: "Learn how to generate QR codes with the Dub API."
+hidden: true
 ---

guides/programs/partner-payout-invoice.mdx (1)

1-6: Consider normalizing title casing for consistency.

Other files in this PR normalize titles to sentence case (e.g., "Referrals embed", "Analytics embed"). This title uses Title Case: "Partner Payout Invoice". Consider changing to "Partner payout invoice" for consistency.

Suggested fix

 ---
-title: "Partner Payout Invoice"
+title: "Partner payout invoice"
 description: "Learn about partner payout invoices on Dub."
 ---

guides/api/track-conversions-with-api.mdx (1)

1-6: Consider normalizing title casing for consistency.

Similar to the other new guide files, this title uses Title Case: "Track Conversions with the API". For consistency with the sentence case normalization applied elsewhere in this PR, consider changing to "Track conversions with the API".

Suggested fix

 ---
-title: "Track Conversions with the API"
+title: "Track conversions with the API"
 description: "Learn how to track conversions with the Dub API."
 ---

guides/link-management/link-double-redirects.mdx (1)

1-6: Placeholder file with no content.

This guide only contains a migration note with no actual documentation content. Consider either adding the migrated content before merging or tracking this as a TODO to ensure it gets completed.

Would you like me to open an issue to track the content migration for this guide?

guides/link-management/how-to-check-link-destination.mdx (1)

1-6: Placeholder file with no content.

Same as other new guides in this PR—this file lacks the actual documentation content. Ensure the migration from the Dub Help Center is completed before or shortly after this PR merges.

guides/link-management/how-noindex-works.mdx (1)

1-6: Placeholder awaiting content migration.

Same observation as other new guides—no substantive content yet. The front matter looks correct.

guides/partners/program-applications.mdx (1)

1-6: Placeholder awaiting content migration.

Front matter is appropriate. Ensure the actual content is migrated from the Help Center.

guides/programs/receiving-payouts.mdx (1)

1-6: Placeholder awaiting content migration.

Front matter is appropriate. This is one of several placeholder guides in this PR—consider adding a tracking mechanism (e.g., GitHub issue or project board) to ensure all migrations are completed.

guides/link-management/link-folders.mdx (1)

1-6: Placeholder guide - content pending migration.

The file structure and front matter are correct. The guide currently contains only a migration note without actual content.

Would you like me to help draft the content for this guide, or should I open an issue to track completion of this migration?

guides/link-management/bulk-link-actions.mdx (1)

1-6: Placeholder guide - content pending migration.

Structure looks good. Content migration from the Help Center is pending.

Let me know if you'd like help drafting the bulk link actions documentation.

guides/link-management/dub-link-builder.mdx (1)

1-6: Placeholder guide - content pending migration.

Front matter and structure are correct. Ready for content migration.

guides/link-management/folders-rbac.mdx (1)

1-6: Placeholder guide - content pending migration.

Front matter correctly describes the RBAC topic for folders. Ready for content migration.

guides/partners/program-analytics.mdx (1)

1-6: Placeholder guide - content pending migration.

Structure and front matter are correct for the partner program analytics guide.

guides/link-management/custom-link-previews.mdx (1)

1-6: Placeholder guide - content pending migration.

Front matter and structure are correct. Ready for content migration.

guides/getting-started/how-to-change-default-workspace.mdx (1)

1-6: Consider adding a minimal actionable stub.

The page is currently just a migration note. If it will appear in navigation now, consider adding a short summary + direct help-article pointer or marking the page as draft/hidden (if supported) until the full migration lands.

guides/custom-domains/how-to-redirect-root-domain.mdx (1)

1-6: Stub file pending content migration.

This placeholder references the Help Center but provides no actual guide content. Consider adding a more specific link to the relevant Help Center article (e.g., https://dub.co/help/article/redirect-root-domain) so users can find the information while migration is in progress.

guides/partners/program-landing-page.mdx (1)

1-6: Stub file pending content migration.

Same feedback as other stub files—consider linking to the specific Help Center article for the program landing page topic while migration is in progress.

guides/custom-domains/how-to-add-custom-domain.mdx (1)

1-6: Stub file pending content migration.

Consistent with the other stub files. The generic Help Center link works but a direct link to the custom domain article would improve user experience during the migration period.

guides/custom-domains/how-to-set-primary-domain.mdx (1)

1-6: Placeholder content may confuse users.

This guide contains no actual content—just a migration notice. Users searching for help on setting a primary domain will find no instructions here.

Consider either:

1. Completing the migration with the actual content, or
2. Linking directly to the specific Help Center article for this topic instead of the generic homepage, or
3. Marking this file as a draft/hidden until content is ready

guides/partners/dub-partners.mdx (1)

1-6: Same concern: placeholder with no actionable content.

As with the other file, this guide offers no information about Dub Partners—only a migration notice. Given that "Dub Partners" appears to be a key feature area, users landing here expecting to learn about affiliate and referral programs will be left without guidance.

If the full content isn't ready, consider linking to the specific Help Center article or keeping the file out of the published docs until migration is complete.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix mobile SDK links to match the mobile SDK paths.

Line 113 links to \/sdks/client-side/swift`and`/sdks/client-side/react-native`, but the navigation uses the mobile SDK path prefix (e.g., `/sdks/client-side-mobile/...``). These links will likely 404.

🔧 Suggested fix

-Dub also offers **Mobile SDKs** ([Swift](/sdks/client-side/swift), [React Native](/sdks/client-side/react-native)) for native app conversion tracking, and **Auth framework integrations** ([Clerk](/conversions/leads/clerk), [Better Auth](/conversions/leads/better-auth), [Auth0](/conversions/leads/auth0)) to automatically track signups as lead events.
+Dub also offers **Mobile SDKs** ([Swift](/sdks/client-side-mobile/installation-guides/swift), [React Native](/sdks/client-side-mobile/installation-guides/react-native)) for native app conversion tracking, and **Auth framework integrations** ([Clerk](/conversions/leads/clerk), [Better Auth](/conversions/leads/better-auth), [Auth0](/conversions/leads/auth0)) to automatically track signups as lead events.

📝 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.

Suggested change

	## Integration options
	Choose the integration method that best fits your stack to track leads and sales:
	### Payment integrations
	<CardGroup cols={2}>
	<Card title="Stripe" icon="stripe-s" href="/conversions/sales/stripe">
	**Best for:** SaaS and subscription revenue tracking. Automatically track purchases, subscriptions, and refunds
	</Card>
	<Card title="Shopify" icon="shopify" href="/conversions/sales/shopify">
	**Best for:** E-commerce revenue tracking. Native app that automatically tracks all orders
	</Card>
	</CardGroup>
	### Lead tracking
	<CardGroup cols={2}>
	<Card title="Google Tag Manager" icon="google" href="/conversions/leads/google-tag-manager">
	**Best for:** Client-side lead event tracking. No-code setup for any platform
	</Card>
	<Card title="HubSpot" icon="hubspot" href="/conversions/leads/hubspot">
	**Best for:** CRM lead tracking. Sync leads and deals directly to your CRM
	</Card>
	</CardGroup>
	### Server-side SDKs
	<CardGroup cols={3}>
	<Card title="TypeScript" icon="js" href="/sdks/typescript">
	TypeScript SDK for Node.js
	</Card>
	<Card title="Python" icon="python" href="/sdks/python">
	Python SDK for server-side integration
	</Card>
	<Card title="Go" icon="golang" href="/sdks/go">
	Go SDK for backend services
	</Card>
	<Card title="PHP" icon="php" href="/sdks/php">
	PHP SDK for web applications
	</Card>
	<Card title="Ruby" icon="gem" href="/sdks/ruby">
	Ruby SDK for Rails and more
	</Card>
	</CardGroup>
	Dub also offers **Mobile SDKs** ([Swift](/sdks/client-side/swift), [React Native](/sdks/client-side/react-native)) for native app conversion tracking, and **Auth framework integrations** ([Clerk](/conversions/leads/clerk), [Better Auth](/conversions/leads/better-auth), [Auth0](/conversions/leads/auth0)) to automatically track signups as lead events.
	## Integration options
	Choose the integration method that best fits your stack to track leads and sales:
	### Payment integrations
	<CardGroup cols={2}>
	<Card title="Stripe" icon="stripe-s" href="/conversions/sales/stripe">
	**Best for:** SaaS and subscription revenue tracking. Automatically track purchases, subscriptions, and refunds
	</Card>
	<Card title="Shopify" icon="shopify" href="/conversions/sales/shopify">
	**Best for:** E-commerce revenue tracking. Native app that automatically tracks all orders
	</Card>
	</CardGroup>
	### Lead tracking
	<CardGroup cols={2}>
	<Card title="Google Tag Manager" icon="google" href="/conversions/leads/google-tag-manager">
	**Best for:** Client-side lead event tracking. No-code setup for any platform
	</Card>
	<Card title="HubSpot" icon="hubspot" href="/conversions/leads/hubspot">
	**Best for:** CRM lead tracking. Sync leads and deals directly to your CRM
	</Card>
	</CardGroup>
	### Server-side SDKs
	<CardGroup cols={3}>
	<Card title="TypeScript" icon="js" href="/sdks/typescript">
	TypeScript SDK for Node.js
	</Card>
	<Card title="Python" icon="python" href="/sdks/python">
	Python SDK for server-side integration
	</Card>
	<Card title="Go" icon="golang" href="/sdks/go">
	Go SDK for backend services
	</Card>
	<Card title="PHP" icon="php" href="/sdks/php">
	PHP SDK for web applications
	</Card>
	<Card title="Ruby" icon="gem" href="/sdks/ruby">
	Ruby SDK for Rails and more
	</Card>
	</CardGroup>
	Dub also offers **Mobile SDKs** ([Swift](/sdks/client-side-mobile/installation-guides/swift), [React Native](/sdks/client-side-mobile/installation-guides/react-native)) for native app conversion tracking, and **Auth framework integrations** ([Clerk](/conversions/leads/clerk), [Better Auth](/conversions/leads/better-auth), [Auth0](/conversions/leads/auth0)) to automatically track signups as lead events.

🤖 Prompt for AI Agents

In `@conversions/quickstart.mdx` around lines 67 - 113, Update the two mobile SDK
links in the "Dub also offers Mobile SDKs" sentence so they use the mobile SDK
path prefix; replace "/sdks/client-side/swift" with
"/sdks/client-side-mobile/swift" and "/sdks/client-side/react-native" with
"/sdks/client-side-mobile/react-native" in the JSX/MDX block that renders the
mobile SDK links (the line containing "Dub also offers **Mobile SDKs**").

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Consider completing the guide content before publishing.

The frontmatter promises to teach users how to import CSV files, but the body only contains a migration notice. Users landing on this page expecting instructional content will find no actionable steps. Consider either completing the guide with the actual import instructions or temporarily removing it from navigation until the content is ready.

🤖 Prompt for AI Agents

In `@guides/getting-started/how-to-import-csv.mdx` around lines 1 - 6, The guide
titled "How to Import a CSV" currently contains only a migration notice and no
actionable steps; replace or supplement the placeholder with a complete how-to:
add a clear step-by-step walkthrough (prereqs, CSV format requirements, UI path
or CLI commands to import, field mapping examples, error
handling/troubleshooting, and a short example CSV), or remove the page from
navigation until ready; locate the file by its frontmatter title "How to Import
a CSV" and update the body content accordingly to include the full import
instructions.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Hyphenate "geo-targeting" for grammatical correctness.

The compound adjective "geo targeting" should be hyphenated when used as a modifier.

✏️ Suggested fix

-- **Device & geo targeting** - Redirect users based on device type or location
+- **Device & geo-targeting** - Redirect users based on device type or location

📝 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.

Suggested change

	- **Device & geo targeting** - Redirect users based on device type or location
	- **Device & geo-targeting** - Redirect users based on device type or location

🧰 Tools

🪛 LanguageTool

[grammar] ~48-~48: Use a hyphen to join words.
Context: ...s using your own domain - Device & geo targeting - Redirect users based on de...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents

In `@guides/getting-started/introduction.mdx` at line 48, Update the phrase
"Device & geo targeting" in the introduction content to use the hyphenated
compound adjective: change it to "Device & geo-targeting" so the modifier is
grammatically correct.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Complete the guide content before merging.

This file currently contains only a migration notice with no actual guide content. Publishing documentation stubs degrades the user experience, as visitors will find no actionable information about navigating a partner program.

Consider one of the following approaches:

1. Complete the migration by adding the actual guide content before merging this PR.
2. Provide a direct link to the specific Help Center article about navigating partner programs (rather than the generic Help Center home page) so users can access the current content.
3. Defer this file until the migration is complete, rather than publishing an empty placeholder.

📝 Example of a more helpful placeholder

If you need to merge this before the content is ready, consider adding more specific guidance:

 ---
 title: "Navigating a Partner Program"
 description: "Learn how to navigate a partner program on Dub."
 ---
 
-This guide is being migrated from the [Dub Help Center](https://dub.co/help).
+<Note>
+  This guide is currently being migrated. In the meantime, please refer to the
+  [Partner Program Navigation article](https://dub.co/help/article/navigating-partner-program) 
+  in the Dub Help Center.
+</Note>

Note: Replace the example URL with the actual Help Center article URL for this specific guide.

🤖 Prompt for AI Agents

In `@guides/programs/navigating-partner-program.mdx` around lines 1 - 6, The file
with frontmatter title "Navigating a Partner Program" currently only contains a
migration notice and no guide content; either populate the document with the
full migrated guide text under that title, replace the placeholder link with the
specific Help Center article URL for "Navigating a Partner Program", or
remove/hold the file until the migration is complete to avoid publishing an
empty stub—update the body below the frontmatter (the content under the title
and description) accordingly to implement one of these options.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find documentation files with migration stubs
rg -l "being migrated from the.*Dub Help Center" --glob '*.mdx' --glob '*.md' -A 2

Repository: dubinc/docs

Length of output: 4865

---

Incomplete guide creates poor user experience.

The page metadata promises to teach users "how to set up Azure SCIM provisioning with Dub," but the content only contains a migration notice. Users landing on this page cannot complete their intended task.

This appears to be part of a larger migration effort affecting 60+ documentation files. However, the individual file still needs attention:

• Complete the migration before merging to provide the actual setup instructions
• Add a direct link to the specific help center article (e.g., [current guide](https://dub.co/help/article/azure-scim)) so users can access the content immediately
• Use a more informative placeholder like "Coming soon" with an expected timeline

🤖 Prompt for AI Agents

In `@guides/saml-sso/azure-scim.mdx` around lines 1 - 6, The Azure SCIM guide
(file guides/saml-sso/azure-scim.mdx, frontmatter title "Azure SCIM") is
incomplete; replace the migration-only content with either the full migrated
setup steps or at minimum add a direct link to the original help-center article,
a clear "Coming soon" placeholder with an expected ETA, and a short summary of
the key setup steps; specifically update the body to include (1) a link such as
[current guide](https://dub.co/help/article/azure-scim), (2) a concise "Coming
soon — expected by <date>" placeholder if full content isn't ready, and (3) a
TODO note that the full migration should include the SCIM provisioning
prerequisites, Azure AD app configuration steps, SCIM attribute mappings, and
testing/verification steps so reviewers can see what's missing.