Skip to content

Conversation

devkiran
Copy link
Collaborator

@devkiran devkiran commented Jul 30, 2025

Summary by CodeRabbit

  • Documentation
    • Updated examples to use higher-level analytics hooks and objects instead of direct cookie access.
    • Added detailed React and vanilla JavaScript examples for displaying referral discount banners.
    • Expanded guidance and code samples for manual click tracking, including usage in different frameworks.
    • Improved clarity by removing manual URL decoding instructions.

devkiran added 2 commits July 30, 2025 19:07
…ing `useAnalytics()` and `trackClick()` functions, including code snippets for React and other frameworks.
Copy link
Contributor

coderabbitai bot commented Jul 30, 2025

Walkthrough

The documentation for client-side click tracking was revised to replace low-level cookie access examples with higher-level SDK usage, specifically the useAnalytics() React hook and DubAnalytics object. Expanded guidance and code samples for programmatic click tracking using trackClick() were also added, clarifying parameters and usage in both React and non-React contexts.

Changes

Cohort / File(s) Change Summary
Client-side Click Tracking Documentation
sdks/client-side/features/client-side-click-tracking.mdx
Updated to use useAnalytics() and DubAnalytics for data access; added detailed trackClick() usage guidance and examples; removed manual cookie parsing and decoding.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In docs we hop, from low to high,
Cookies behind us, SDKs up in the sky.
With hooks and helpers, the code is neat,
Clicks tracked smartly—oh, what a treat!
A banner appears, the bunny approves,
As analytics magic smoothly moves. 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-client-side-tracking

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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

🧹 Nitpick comments (1)
sdks/client-side/features/client-side-click-tracking.mdx (1)

257-272: Double-check the global used for trackClick in non-React example

Here you call dubAnalytics.trackClick, whereas earlier examples use the DubAnalytics object. Aligning the naming (or adding a note clarifying both APIs) will prevent confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0334116 and d352e83.

📒 Files selected for processing (1)
  • sdks/client-side/features/client-side-click-tracking.mdx (2 hunks)
🔇 Additional comments (1)
sdks/client-side/features/client-side-click-tracking.mdx (1)

181-183: Inconsistent global identifiers may confuse integrators

You mix the lowercase function dubAnalytics("ready", …) with the uppercase object DubAnalytics.partner/discount. Please double-check which symbol the SDK actually exposes and keep the examples consistent to avoid copy-paste errors.

@steven-tey steven-tey merged commit 462bf9b into main Jul 30, 2025
2 checks passed
@steven-tey steven-tey deleted the update-client-side-tracking branch July 30, 2025 16:27
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.

2 participants