supabase cdc guide outline

[DatGuyJonathan]

Note

Low Risk
Low risk: docs-only additions plus a navigation entry; no runtime logic changes beyond making a new draft page discoverable in guides navigation.

Overview
Adds a new draft guide page, guides/supabase-cdc, outlining a Supabase Realtime → Moose workflow → ClickHouse CDC pattern (with architecture diagram, tutorial sections, and reference project structure).

Updates guides navigation to include the new draft “Real-Time CDC from Supabase” page with description, IconBolt, and TypeScript language metadata.

^{Written by Cursor Bugbot for commit a9432e2. This will update automatically on new commits. Configure here.}

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
docs-v2	Ready	Preview, 💬 3 unresolved	Feb 5, 2026 6:07pm

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Added a new guide for real-time data synchronization from Supabase to ClickHouse using workflows, including architecture overview, prerequisites, step-by-step tutorial, and troubleshooting guidance for TypeScript projects.

Walkthrough

Adds a new "Real-Time CDC from Supabase" documentation guide with comprehensive sections covering overview, architecture, prerequisites, and multi-part tutorials for syncing Supabase PostgreSQL to ClickHouse via Moose workflows, plus corresponding navigation configuration.

Changes

Cohort / File(s)	Summary
Documentation Guide apps/framework-docs-v2/content/guides/supabase-cdc.mdx	New MDX guide scaffolding real-time CDC patterns from Supabase to ClickHouse; includes metadata, component imports, architecture overview, six-part tutorial placeholders, TypeScript code samples, Mermaid flow diagram, and project structure reference.
Navigation Configuration apps/framework-docs-v2/src/config/navigation.ts	Added draft-status guide entry to guidesNavigationConfig with title, description, bolt icon, and TypeScript language tag.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

• release - guides #3322 — Modified guide layout handling and navigation types that this new guide entry integrates with.

Suggested reviewers

• callicles
• oatsandsugar

Poem

🌊 Data flows from Supabase shores,
Through Moose's CDC doors,
To ClickHouse—real-time, pure delight,
A guide to sync it just right ⚡

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title concisely summarizes the main change: adding a new Supabase CDC guide outline to the documentation.
Description check	✅ Passed	Description is clearly related to the changeset, explaining the addition of a draft guide page and navigation update.
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 docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cdc-supabase-guide-outline

---

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: 1

🤖 Fix all issues with AI agents

In `@apps/framework-docs-v2/content/guides/supabase-cdc.mdx`:
- Line 7: The import line currently includes unused components BulletPointsCard
and ToggleBlock; remove those two symbols from the import list so only the used
components (FileTree, CTACards, CTACard, Callout) are imported and verify there
are no remaining references to BulletPointsCard or ToggleBlock in the MDX
content (update or remove any usages if found).

📜 Review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f393001 and a9432e2.

📒 Files selected for processing (2)

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx
• apps/framework-docs-v2/src/config/navigation.ts

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Run linting checks before submitting PRs for TypeScript/JavaScript code

**/*.{ts,tsx,js,jsx}: Group imports by external dependencies, internal modules, and types; use named exports from barrel files (index.ts)
Use camelCase for variables and functions, PascalCase for types/classes/components, UPPER_SNAKE_CASE for constants in TypeScript/JavaScript
Prefix unused variables with underscore (e.g., _unusedParam) to bypass linting errors in TypeScript/JavaScript
Format TypeScript/JavaScript code with Prettier using experimentalTernaries: true; auto-formats on commit via Husky + lint-staged

Files:

• apps/framework-docs-v2/src/config/navigation.ts

apps/framework-docs-v2/src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

Component library must use shadcn/ui components located in src/components/ui/

Files:

• apps/framework-docs-v2/src/config/navigation.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Prefer interfaces for objects, types for unions/intersections in TypeScript; explicit return types on public APIs

Files:

• apps/framework-docs-v2/src/config/navigation.ts

apps/framework-docs-v2/content/**/*.mdx

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

apps/framework-docs-v2/content/**/*.mdx: Use {{ include "shared/path.mdx" }} directives to reuse content fragments, which are processed via processIncludes() during build
Validate code snippets in documentation with the @test directive for TypeScript and Python code blocks
TypeScript code snippets in documentation should be validated for syntax with brace matching; Python snippets should be validated for indentation

Files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

apps/framework-docs-v2/content/guides/**/*.mdx

📄 CodeRabbit inference engine (apps/framework-docs-v2/CLAUDE.md)

Guide MDX files in content/guides/ must include frontmatter with title and description fields

Files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

🧠 Learnings (8)

📚 Learning: 2026-01-22T19:02:52.316Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Add new guides to `guidesNavigationConfig` in `src/config/navigation.ts` with required fields: type, slug, title, icon, languages, and status (start as 'draft')

Applied to files:

• apps/framework-docs-v2/src/config/navigation.ts

📚 Learning: 2026-01-22T19:02:52.316Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Guide promotion workflow: start guides with `status: "draft"` in navigation config, then progress to `status: "beta"`, finally remove status field for public release

Applied to files:

• apps/framework-docs-v2/src/config/navigation.ts

📚 Learning: 2026-01-22T19:02:52.316Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Use Vercel Toolbar feature flags for visibility control: `show-draft-guides`, `show-beta-guides`, `show-hosting-section`, `show-ai-section`, `show-copy-as-markdown`, `show-linear-integration`

Applied to files:

• apps/framework-docs-v2/src/config/navigation.ts

📚 Learning: 2026-01-22T19:02:52.316Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: apps/framework-docs-v2/CLAUDE.md:0-0
Timestamp: 2026-01-22T19:02:52.316Z
Learning: Applies to apps/framework-docs-v2/content/guides/**/*.mdx : Guide MDX files in `content/guides/` must include frontmatter with title and description fields

Applied to files:

• apps/framework-docs-v2/src/config/navigation.ts
• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

📚 Learning: 2026-01-15T19:41:53.563Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: examples/cdp-analytics/CLAUDE.md:0-0
Timestamp: 2026-01-15T19:41:53.563Z
Learning: Applies to examples/cdp-analytics/app/views/*.ts : Use SummingMergeTree engine for materialized views that require incremental updates, and wrap aggregated metrics with SUM() when querying to properly merge partial rows

Applied to files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

📚 Learning: 2026-01-27T17:36:29.854Z

Learnt from: CR
Repo: 514-labs/moosestack PR: 0
File: examples/nextjs-moose/CLAUDE.md:0-0
Timestamp: 2026-01-27T17:36:29.854Z
Learning: The moose query layer represents a two-step OLAP migration pattern: Step 1 (not shown) shifts just-in-time joins to write-time via Materialized Views; Step 2 (this demo) accelerates endpoint creation with the query layer. This architecture assumes MVs/OLAP tables already exist and focuses on the read-time query selection and filtering layer

Applied to files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

📚 Learning: 2026-01-28T14:50:00.978Z

Learnt from: cjus
Repo: 514-labs/moosestack PR: 3407
File: apps/framework-docs-v2/content/guides/static-report-generation.mdx:1402-1406
Timestamp: 2026-01-28T14:50:00.978Z
Learning: When reviewing WebApp implementations that run in a Node.js backend, prefer Node.js-specific types (e.g., Buffer) and avoid browser-focused cross-platform compatibility considerations. This guideline applies to MDX documentation and code examples across the repository where backend/runtime code is discussed; ensure reviewers distinguish server-side context from frontend/browser constraints and validate type usage accordingly.

Applied to files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

📚 Learning: 2026-01-28T14:55:13.411Z

Learnt from: cjus
Repo: 514-labs/moosestack PR: 3407
File: apps/framework-docs-v2/content/guides/static-report-generation.mdx:1585-1616
Timestamp: 2026-01-28T14:55:13.411Z
Learning: In documentation and tutorial files under apps/framework-docs-v2/content/guides/, prefer explicit, self-contained code examples that may duplicate small snippets for clarity over abstracting with DRY helpers. Ensure examples are easy to understand in isolation, even if it means a bit of repetition, to aid learning and reduce cognitive load for readers.

Applied to files:

• apps/framework-docs-v2/content/guides/supabase-cdc.mdx

🔇 Additional comments (4)

apps/framework-docs-v2/src/config/navigation.ts (1)

1253-1262: LGTM!

Navigation entry includes all required fields (type, slug, title, icon, languages, status) and correctly starts with status: "draft". Based on learnings: "Add new guides to guidesNavigationConfig with required fields: type, slug, title, icon, languages, and status (start as 'draft')".

apps/framework-docs-v2/content/guides/supabase-cdc.mdx (3)

1-5: LGTM!

Frontmatter includes required title and description fields. As per coding guidelines: "Guide MDX files in content/guides/ must include frontmatter with title and description fields".

---

82-101: LGTM!

Mermaid diagram clearly illustrates the architecture: Supabase → Moose Workflow → OlapTable → ClickHouse → API.

---

236-256: LGTM!

FileTree structure aligns with standard Moose project layout and matches the described architecture.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[linear]

514-353 cdc guide with supabase