Skip to content

CLAUDE.md

Latest commit

 

History

History
38 lines (27 loc) · 1.25 KB

CLAUDE.md

File metadata and controls

38 lines (27 loc) · 1.25 KB
Raw

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

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