From 25dad0c52a05d362de522682319c8f057ae28663 Mon Sep 17 00:00:00 2001 From: Jared Scott Date: Mon, 2 Feb 2026 09:04:58 +0800 Subject: [PATCH] feat(DRC-1727): Add Subscribe to Newsletter link to Recce Docs Signed-off-by: Jared Scott --- CLAUDE.md | 38 +++++++++++++ claude/KNOWLEDGE_BASE.md | 58 ++++++++++++++++++++ docs/1-whats-recce/community-support.md | 27 ++++++---- docs/javascripts/hubspot-form.js | 14 +++++ docs/overrides/main.html | 6 +++ docs/styles/extra.css | 71 +++++++++++++++++++++++++ mkdocs.yml | 3 ++ 7 files changed, 207 insertions(+), 10 deletions(-) create mode 100644 CLAUDE.md create mode 100644 claude/KNOWLEDGE_BASE.md create mode 100644 docs/javascripts/hubspot-form.js diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..bf2b80e4 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,38 @@ +# Recce Documentation Site + +Documentation for Recce, a Data Review Agent that automates data validation for dbt pull requests. Built with MkDocs Material theme. + +## Tech Stack + +- MkDocs + Material theme (Python) +- Node.js (Sass/Bootstrap) +- GitHub Actions (CI/CD) + +## Commands + +```shell +pip install -r requirements.txt # Install Python deps +npm install # Install Node deps +mkdocs serve # Local dev server (localhost:8000) +mkdocs build # Build static site to /site +``` + +## Key Patterns + +1. **Cloud-first**: Present Recce Cloud as primary, OSS as alternative +2. **Data-team language**: Use "validation" not "testing", "release" not "deploy", "development stage" not "environment" +3. **8-section structure**: What's Recce → Getting Started → Visualized Change → Downstream Impacts → Data Diffing → Collaboration → CI/CD → Technical Concepts + +## File Structure + +| Path | Purpose | +|------|---------| +| `docs/` | Markdown source files (numbered sections) | +| `mkdocs.yml` | Site config and nav structure | +| `claude/` | Writing principles and terminology guides | +| `docs/assets/images/` | Screenshots and diagrams | +| `site/` | Built output (git-ignored) | + +## Knowledge Base + +→ `claude/KNOWLEDGE_BASE.md` diff --git a/claude/KNOWLEDGE_BASE.md b/claude/KNOWLEDGE_BASE.md new file mode 100644 index 00000000..be0e85e6 --- /dev/null +++ b/claude/KNOWLEDGE_BASE.md @@ -0,0 +1,58 @@ +# Knowledge Base + +## Documentation Structure +8 numbered sections mirror user adoption flow: understand → get started → use features → collaborate → automate → technical details. +→ `mkdocs.yml` (nav section) + +## Writing Standards +Cloud-first, data-team-friendly language. Avoid software engineering jargon. Use "validation" not "testing", "release" not "deploy". +→ `claude/writing-principles.md` + +## Terminology +Preferred terms for Recce features and data team concepts. Includes confusion alert patterns. +→ `claude/terminology.md` + +## Content Sections + +### What's Recce (Section 1) +Value proposition and how the Data Review Agent automates PR validation. +→ `docs/1-whats-recce/` + +### Getting Started (Section 2) +OSS vs Cloud comparison, installation, Jaffle Shop tutorial. +→ `docs/2-getting-started/` + +### Visualized Change (Section 3) +Lineage diffs, code changes, column-level lineage, multi-model views. +→ `docs/3-visualized-change/` + +### Downstream Impacts (Section 4) +Impact radius analysis and breaking change detection. +→ `docs/4-downstream-impacts/` + +### Data Diffing (Section 5) +Row count, profile, value, top-K, histogram diffs, custom queries, warehouse connections. +→ `docs/5-data-diffing/` + +### Collaboration (Section 6) +Team invitations, validation checklists, sharing findings. +→ `docs/6-collaboration/` + +### CI/CD (Section 7) +GitHub/GitLab integration, PR summaries, preset checks, best practices. +→ `docs/7-cicd/` + +### Technical Concepts (Section 8) +State files and configuration reference. +→ `docs/8-technical-concepts/` + +## Site Configuration +MkDocs Material theme config, nav structure, plugins, extensions. +→ `mkdocs.yml` + +## Styling +Custom CSS in `docs/styles/extra.css`, theme overrides in `docs/overrides/`. + +## Images +Optimize PNGs with pngquant. Keep animated GIFs under 1MB. +→ `readme.md` (Images section) diff --git a/docs/1-whats-recce/community-support.md b/docs/1-whats-recce/community-support.md index 9e797d59..fd125ce5 100644 --- a/docs/1-whats-recce/community-support.md +++ b/docs/1-whats-recce/community-support.md @@ -4,23 +4,30 @@ title: Community & Support # Community & Support -Here's where you can get in touch with the Recce team and find support, add a subscribe to our newsletter option as well: +Here's where you can get in touch with the Recce team and find support: -- [chat on our website](https://reccehq.com). We welcome you to start a chat or drop us a note. Our team monitors the chat box and will follow up soon. - [Our discord](https://discord.com/invite/VpwXRC34jz) -- [dbt Slack](https://www.getdbt.com/community/join-the-community) in the [#tools-recce](https://getdbt.slack.com/archives/C05C28V7CPP) channel -- Email us [help@reccehq.com](mailto:help@reccehq.com) +- [dbt Slack](https://www.getdbt.com/community/join-the-community) in the [#tools-recce](https://getdbt.slack.com/archives/C05C28V7CPP) channel +- Email us [help@reccehq.com](mailto:help@reccehq.com) -If you believe you have found a bug on our open source, or there is some missing functionality in Recce, please open a [GitHub Issue](https://github.com/DataRecce/recce/issues). +If you believe you have found a bug on our open source, or there is some missing functionality in Recce, please open a [GitHub Issue](https://github.com/DataRecce/recce/issues). ## Recce on the web -You can follow along with news about Recce and blogs from our team in the following places: +You can follow along with news about Recce and blogs from our team in the following places: -- Subscribe to ournewsletter - [LinkedIn](https://www.linkedin.com/company/datarecce) - [Recce Blog](https://blog.reccehq.com/) -- [@datarecce](https://x.com/DataRecce) on Twitter/X -- [@DataRecce@mastodon.social](https://mastodon.social/@DataRecce) on Mastodon -- [@datarecce.bsky.social](https://bsky.app/profile/datarecce.bsky.social) on BlueSky +- [@datarecce](https://x.com/DataRecce) on Twitter/X +- [@DataRecce@mastodon.social](https://mastodon.social/@DataRecce) on Mastodon +- [@datarecce.bsky.social](https://bsky.app/profile/datarecce.bsky.social) on BlueSky + +## Subscribe to our newsletter + +Stay updated with Recce news, data engineering insights, and product updates. + +
+

Sign up for Recce Updates

+
+
diff --git a/docs/javascripts/hubspot-form.js b/docs/javascripts/hubspot-form.js new file mode 100644 index 00000000..3ce5ab0b --- /dev/null +++ b/docs/javascripts/hubspot-form.js @@ -0,0 +1,14 @@ +// HubSpot Newsletter Form Initialization +document.addEventListener("DOMContentLoaded", function () { + var formContainer = document.getElementById("hubspot-newsletter-form"); + + if (formContainer && window.hbspt && window.hbspt.forms) { + window.hbspt.forms.create({ + portalId: "242432742", + formId: "df4190b8-3804-4c1e-98c6-f73625ef5d01", + region: "na2", + css: "", + target: "#hubspot-newsletter-form", + }); + } +}); diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 7fe3c08f..3cbe8e48 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -12,6 +12,12 @@ {{ super() }} {% endblock %} +{% block scripts %} +{{ super() }} + + +{% endblock %} + {% block header %}