Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -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`
58 changes: 58 additions & 0 deletions claude/KNOWLEDGE_BASE.md
Original file line number Diff line number Diff line change
@@ -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)
27 changes: 17 additions & 10 deletions docs/1-whats-recce/community-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div class="hubspot-newsletter-wrapper">
<h3>Sign up for Recce Updates</h3>
<div id="hubspot-newsletter-form"></div>
</div>
14 changes: 14 additions & 0 deletions docs/javascripts/hubspot-form.js
Original file line number Diff line number Diff line change
@@ -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",
});
}
});
6 changes: 6 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
{{ super() }}
{% endblock %}

{% block scripts %}
{{ super() }}
<!-- HubSpot Forms Embed Script -->
<script charset="utf-8" type="text/javascript" src="//js-na2.hsforms.net/forms/embed/v2.js"></script>
{% endblock %}

{% block header %}
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-N34SPDW8"
Expand Down
71 changes: 71 additions & 0 deletions docs/styles/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -289,3 +289,74 @@ header .btn.btn-primary:active {
filter: saturate(90%);
cursor: pointer;
}

/**** HubSpot Newsletter Form ****/

.hubspot-newsletter-wrapper {
background-color: var(--md-primary-fg-color);
border-radius: 0.5rem;
padding: 1.5rem;
margin: 1rem 0;
color: #fff;
}

.hubspot-newsletter-wrapper h3 {
color: #fff;
margin-top: 0;
margin-bottom: 1rem;
font-size: 0.95rem;
font-weight: 500;
}

#hubspot-newsletter-form .hs-form-field {
margin-bottom: 0.75rem;
}

#hubspot-newsletter-form .hs-form-field label {
color: #fff;
font-weight: 500;
font-size: 0.85rem;
margin-bottom: 0.25rem;
display: block;
}

#hubspot-newsletter-form .hs-input {
width: 100%;
padding: 0.4rem 0.6rem;
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 0.25rem;
background-color: rgba(255, 255, 255, 0.95);
font-size: 0.8rem;
}

#hubspot-newsletter-form .hs-input:focus {
outline: none;
border-color: var(--md-typeset-a-color);
box-shadow: 0 0 0 2px rgba(255, 110, 66, 0.2);
}

#hubspot-newsletter-form .hs-button {
background-color: var(--md-typeset-a-color);
color: #fff;
border: none;
padding: 0.6rem 1.5rem;
border-radius: 0.25rem;
font-weight: 600;
cursor: pointer;
transition: background-color 0.2s ease;
}

#hubspot-newsletter-form .hs-button:hover {
background-color: #e04f23;
}

#hubspot-newsletter-form .hs-error-msgs {
color: #ffcccc;
font-size: 0.85rem;
margin-top: 0.25rem;
}

#hubspot-newsletter-form .submitted-message {
color: #fff;
font-weight: 500;
}
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ site_url: https://docs.reccehq.com
extra_css:
- styles/extra.css

extra_javascript:
- javascripts/hubspot-form.js

extra:
generator: false
social:
Expand Down