docs: add troubleshooting section for common setup issues

[sehawq]

This PR adds a troubleshooting section to the README to help users resolve common setup issues.

Changes

• Added "Troubleshooting" section after API Reference
• Covers 3 common issues based on repository feedback

Motivation

Issue #7 shows users struggle with syncing existing products when connecting to an established Polar account. The webhook-based sync only catches new products, which isn't obvious from the current docs.

Testing

• Verified markdown renders correctly
• Checked all code examples for accuracy
• Confirmed solutions match actual component behavior

Summary by CodeRabbit

• Documentation
  • Added comprehensive Troubleshooting section providing guidance on syncing existing products, handling webhooks, and resolving TypeScript errors
  • Included practical examples and detailed instructions for executing product synchronization operations
  • Added guidance on webhook URL verification, deployment configuration, and event handler registration
  • Provided step-by-step instructions for testing webhook delivery functionality

[coderabbitai]

📝 Walkthrough

Walkthrough

A new Troubleshooting section was added to the README.md documentation, providing guidance on synchronizing existing Polar products, handling webhooks, and resolving TypeScript errors. The section includes code examples and step-by-step instructions for configuration and testing.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added Troubleshooting section with examples for product synchronization, webhook configuration, webhook delivery testing, and TypeScript error troubleshooting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 ✨ A carrot-full of words, so fine,
In Troubleshooting, all will align,
Webhooks and sync, now crystal clear,
Our fuzzy friends have nothing to fear! 🌟

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding a troubleshooting section to the README for common setup issues. It accurately reflects the primary objective and content of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

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

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

README.md (1)

576-595: Good troubleshooting guidance that addresses Issue #7.

The explanation and solution are accurate and directly address the webhook sync limitation for existing products. The code example correctly demonstrates using polar.syncProducts(ctx).

One minor clarity suggestion: The example shows creating the action in convex/polar.ts, but users following earlier sections have their polar instance in convex/example.ts. Consider mentioning that this action can be added to any Convex file (including example.ts), and the run command should match the chosen file:

npx convex run <filename>:syncExistingProducts

This would help users avoid confusion if they add the action to their existing example.ts file.

---

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