Skip to content

Conversation

@lindesvard
Copy link
Contributor

@lindesvard lindesvard commented Dec 15, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Added comprehensive implementation guides for setting up OpenPanel analytics across multiple frameworks (Astro, Express, Next.js, Node.js, Python, React, React Native, Kotlin, Swift, Vue, Remix).
    • Added specialized guides for e-commerce tracking, custom events, website analytics, and migration from Google Analytics and Mixpanel.
    • Launched new Guides section accessible from the main navigation.
  • Documentation

    • Added callout links in SDK documentation directing users to framework-specific setup guides.
    • Added "Setup guide" links throughout the SDK index.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Dec 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
openpanel-public Error Error Dec 15, 2025 9:19am

@lindesvard lindesvard merged commit 3d8a3e8 into main Dec 15, 2025
6 of 8 checks passed
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive guides section to the documentation site, adding 16 framework and integration-specific analytics setup guides, guide listing and detail pages with dynamic routing, a guide card component, and configuration updates to support the new guides collection and source system.

Changes

Cohort / File(s) Summary
Guide Content Files
apps/public/content/guides/astro-analytics.mdx, apps/public/content/guides/express-analytics.mdx, apps/public/content/guides/kotlin-analytics.mdx, apps/public/content/guides/nextjs-analytics.mdx, apps/public/content/guides/python-analytics.mdx, apps/public/content/guides/react-native-analytics.mdx, apps/public/content/guides/swift-analytics.mdx, apps/public/content/guides/nodejs-analytics.mdx, apps/public/content/guides/react-analytics.mdx, apps/public/content/guides/remix-analytics.mdx, apps/public/content/guides/vue-analytics.mdx
New framework-specific analytics integration guides covering installation, event tracking, user identification, and verification steps with code examples.
Migration & Topic Guides
apps/public/content/guides/ecommerce-tracking.mdx, apps/public/content/guides/migrate-from-google-analytics.mdx, apps/public/content/guides/migrate-from-mixpanel.mdx, apps/public/content/guides/track-custom-events.mdx, apps/public/content/guides/website-analytics-setup.mdx
New cross-platform guides covering e-commerce event tracking, migration paths from GA4 and Mixpanel, custom event tracking patterns, and website script-tag setup.
SDK Documentation Updates
apps/public/content/docs/(tracking)/sdks/astro.mdx, apps/public/content/docs/(tracking)/sdks/express.mdx, apps/public/content/docs/(tracking)/sdks/kotlin.mdx, apps/public/content/docs/(tracking)/sdks/nextjs.mdx, apps/public/content/docs/(tracking)/sdks/python.mdx, apps/public/content/docs/(tracking)/sdks/react-native.mdx, apps/public/content/docs/(tracking)/sdks/swift.mdx, apps/public/content/docs/(tracking)/sdks/index.mdx
Added Callout components linking to analytics guides and appended "Setup guide" links to SDK index entries.
Guide Pages & Routing
apps/public/src/app/(content)/guides/page.tsx, apps/public/src/app/(content)/guides/[guideSlug]/page.tsx
New Next.js pages for guides listing (with JSON-LD ItemList schema and GuideCard grid) and dynamic guide detail page (with static params generation, metadata, JSON-LD HowTo schema, TOC, related guides, and testimonials).
Guide Card Component
apps/public/src/components/guide-card.tsx
New React component for rendering guide cards with cover image, difficulty badge, time estimate, title, and optional team/date metadata.
Configuration & Source
apps/public/source.config.ts, apps/public/src/lib/source.ts
Added zGuide schema definition and guideCollection/guideMeta exports in source config; exported guideSource loader with baseUrl '/guides' in source module.
Navigation & OG
apps/public/src/components/footer.tsx, apps/public/src/app/og/[...og]/route.tsx
Added "Guides" link to footer Resources section; added 'guides' case in OG image generation to handle guide metadata and defaults.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

  • Dynamic route generation logic in [guideSlug]/page.tsx with JSON-LD schema generation requires careful validation of slug derivation and schema correctness
  • Guide detail page component constructs related guides filtering, author info, and multiple UI sections that need end-to-end verification
  • Content file volume (16 guide files) is substantial; while mostly homogeneous markdown, each should be spot-checked for accuracy, code example validity, and link integrity
  • Source configuration integration needs verification that schema, collections, and loader are correctly wired
  • Footer and OG route changes are relatively straightforward but should confirm fallback behavior

Poem

🐰 Hop along, dear developers, guides are here to stay!
With Astro, Next, and Swift in tow, we've paved analytics way.
From schema tags to cards so bright, from migrations smooth and clear—
The guides garden now blooms full; come explore, have no fear! 🌱✨

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/guides

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28692d8 and bc3d7b7.

📒 Files selected for processing (31)
  • apps/public/content/docs/(tracking)/sdks/astro.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/express.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/index.mdx (4 hunks)
  • apps/public/content/docs/(tracking)/sdks/kotlin.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/nextjs.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/python.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/react-native.mdx (1 hunks)
  • apps/public/content/docs/(tracking)/sdks/swift.mdx (1 hunks)
  • apps/public/content/guides/astro-analytics.mdx (1 hunks)
  • apps/public/content/guides/ecommerce-tracking.mdx (1 hunks)
  • apps/public/content/guides/express-analytics.mdx (1 hunks)
  • apps/public/content/guides/kotlin-analytics.mdx (1 hunks)
  • apps/public/content/guides/migrate-from-google-analytics.mdx (1 hunks)
  • apps/public/content/guides/migrate-from-mixpanel.mdx (1 hunks)
  • apps/public/content/guides/nextjs-analytics.mdx (1 hunks)
  • apps/public/content/guides/nodejs-analytics.mdx (1 hunks)
  • apps/public/content/guides/python-analytics.mdx (1 hunks)
  • apps/public/content/guides/react-analytics.mdx (1 hunks)
  • apps/public/content/guides/react-native-analytics.mdx (1 hunks)
  • apps/public/content/guides/remix-analytics.mdx (1 hunks)
  • apps/public/content/guides/swift-analytics.mdx (1 hunks)
  • apps/public/content/guides/track-custom-events.mdx (1 hunks)
  • apps/public/content/guides/vue-analytics.mdx (1 hunks)
  • apps/public/content/guides/website-analytics-setup.mdx (1 hunks)
  • apps/public/source.config.ts (2 hunks)
  • apps/public/src/app/(content)/guides/[guideSlug]/page.tsx (1 hunks)
  • apps/public/src/app/(content)/guides/page.tsx (1 hunks)
  • apps/public/src/app/og/[...og]/route.tsx (2 hunks)
  • apps/public/src/components/footer.tsx (1 hunks)
  • apps/public/src/components/guide-card.tsx (1 hunks)
  • apps/public/src/lib/source.ts (2 hunks)

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.

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