mkdocs.yml

site_name: Recce Docs
site_description: >-
  Recce is a dbt data validation tool and AI Data Review Agent. Validate dbt
  pull requests with schema diffs, row count diffs, and data diffing via Claude
  Code, Cursor, and Windsurf using the Recce MCP server.

copyright: Copyright &copy; 2026 Recce <br />

# Repository
repo_name: datarecce/recce
repo_url: https://github.com/datarecce/recce
site_url: https://docs.reccehq.com
extra_css:
  - styles/extra.css

extra_javascript:
  - javascripts/hubspot-form.js

extra:
  generator: false
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/HUUx9fyphJ
      name: Recce on Discord
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/datarecce
      name: Recce on X (Twitter)
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/datarecce.bsky.social
      name: Recce on Bluesky
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.social/@DataRecce
      name: Recce on Mastadon
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/datarecce
      name: Recce on LinkedIn
    - icon: fontawesome/brands/medium
      link: https://medium.com/inthepipeline
      name: Recce on Medium
    - icon: fontawesome/brands/github
      link: https://github.com/DataRecce/recce
      name: Recce on GitHub
    - icon: fontawesome/brands/slack
      link: https://getdbt.slack.com/archives/C05C28V7CPP
      name: Recce on Slack

nav:
  - Home: "https://reccehq.com/"
  - Guides:
      - What's Recce:
          - index.md
          - whats-recce/cloud-vs-oss.md
          - Changelog: "https://reccehq.com/changelog/"
      - Getting Started:
          - Start with Cloud: getting-started/start-free-with-cloud.md
          - getting-started/oss-setup.md
          - Tutorial (OSS): getting-started/jaffle-shop-tutorial.md
      - Setup Guides:
          - Connect Your Repository: setup-guides/connect-git.md
          - Connect Data Warehouse: setup-guides/connect-to-warehouse.md
          - Environment Setup: setup-guides/environment-setup.md
          - Environment Best Practices: setup-guides/environment-best-practices.md
          - dbt Cloud Setup: setup-guides/dbt-cloud-setup.md
          - Setup CD: setup-guides/setup-cd.md
          - Setup CI: setup-guides/setup-ci.md
          - Claude Plugin: setup-guides/claude-plugin.md
          - MCP Server (AI Agents): setup-guides/mcp-server.md
      - Using Recce:
          - using-recce/admin-setup.md
          - using-recce/data-developer.md
          - using-recce/data-reviewer.md
          - using-recce/cli-commands.md
          - Workflow in OSS: using-recce/oss-workflow.md
      - What You Can Explore:
          - what-you-can-explore/summary.md
          - what-you-can-explore/lineage-diff.md
          - what-you-can-explore/code-change.md
          - what-you-can-explore/column-level-lineage.md
          - what-you-can-explore/impact-radius.md
          - what-you-can-explore/breaking-change-analysis.md
          - what-you-can-explore/data-diffing.md
          - what-you-can-explore/multi-models.md
      - Collaboration:
          - collaboration/checklist.md
          - collaboration/activity.md
          - collaboration/preset-checks.md
          - collaboration/share.md
      - Reference:
          - technical-concepts/configuration.md
          - technical-concepts/state-file.md

  - Blog: "https://blog.reccehq.com"
  - Changelog: "https://reccehq.com/changelog/"
  - Start Free: "https://cloud.reccehq.com/"

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
        #- toc:
        #   title: On this page


  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true

theme:
  name: material
  logo: assets/images/recce-logo-white.png
  custom_dir: docs/overrides
  palette:
    # Palette toggle for light mode
    - scheme: secondary
      primary: deep orange
      toggle:
        icon: material/brightness-4 # Icon to switch to dark mode
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: secondary-dark
      primary: deep orange
      toggle:
        icon: material/brightness-7 # Icon to switch back to light mode
        name: Switch to light mode

  features:
    # - navigation.instant
    # - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - content.code.copy

plugins:
  - search
  - redirects:
      redirect_maps:
        # Old numbered paths to new unnumbered paths
        '1-whats-recce/cloud-vs-oss.md': 'whats-recce/cloud-vs-oss.md'
        '1-whats-recce/community-support.md': 'whats-recce/cloud-vs-oss.md'
        '2-getting-started/start-free-with-cloud.md': 'getting-started/start-free-with-cloud.md'
        '2-getting-started/oss-setup.md': 'getting-started/oss-setup.md'
        '2-getting-started/jaffle-shop-tutorial.md': 'getting-started/jaffle-shop-tutorial.md'
        '2-getting-started/installation.md': 'getting-started/oss-setup.md'
        '2-getting-started/get-started-jaffle-shop.md': 'getting-started/jaffle-shop-tutorial.md'
        '2-getting-started/oss-vs-cloud.md': 'whats-recce/cloud-vs-oss.md'
        '2-getting-started/connect-git.md': 'setup-guides/connect-git.md'
        '2-getting-started/connect-to-warehouse.md': 'setup-guides/connect-to-warehouse.md'
        '2-getting-started/environment-setup.md': 'setup-guides/environment-setup.md'
        '2-getting-started/environment-best-practices.md': 'setup-guides/environment-best-practices.md'
        '2-getting-started/dbt-cloud-setup.md': 'setup-guides/dbt-cloud-setup.md'
        '2-getting-started/setup-cd.md': 'setup-guides/setup-cd.md'
        '2-getting-started/setup-ci.md': 'setup-guides/setup-ci.md'
        '2-getting-started/claude-plugin.md': 'setup-guides/claude-plugin.md'
        '2-getting-started/gitlab-pat-guide.md': 'setup-guides/connect-git.md'
        '3-using-recce/admin-setup.md': 'using-recce/admin-setup.md'
        '3-using-recce/data-developer.md': 'using-recce/data-developer.md'
        '3-using-recce/data-reviewer.md': 'using-recce/data-reviewer.md'
        '3-visualized-change/lineage.md': 'what-you-can-explore/lineage-diff.md'
        '3-visualized-change/code-change.md': 'what-you-can-explore/code-change.md'
        '3-visualized-change/column-level-lineage.md': 'what-you-can-explore/column-level-lineage.md'
        '3-visualized-change/multi-models.md': 'what-you-can-explore/multi-models.md'
        '4-downstream-impacts/impact-radius.md': 'what-you-can-explore/impact-radius.md'
        '4-downstream-impacts/breaking-change-analysis.md': 'what-you-can-explore/breaking-change-analysis.md'
        '5-what-you-can-explore/summary.md': 'what-you-can-explore/summary.md'
        '5-what-you-can-explore/lineage-diff.md': 'what-you-can-explore/lineage-diff.md'
        '5-what-you-can-explore/code-change.md': 'what-you-can-explore/code-change.md'
        '5-what-you-can-explore/column-level-lineage.md': 'what-you-can-explore/column-level-lineage.md'
        '5-what-you-can-explore/impact-radius.md': 'what-you-can-explore/impact-radius.md'
        '5-what-you-can-explore/breaking-change-analysis.md': 'what-you-can-explore/breaking-change-analysis.md'
        '5-what-you-can-explore/data-diffing.md': 'what-you-can-explore/data-diffing.md'
        '5-what-you-can-explore/multi-models.md': 'what-you-can-explore/multi-models.md'
        '5-data-diffing/row-count-diff.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/profile-diff.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/value-diff.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/topK-diff.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/histogram-diff.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/query.md': 'what-you-can-explore/data-diffing.md'
        '5-data-diffing/mcp-server.md': 'setup-guides/mcp-server.md'
        '5-data-diffing/connect-to-warehouse.md': 'setup-guides/connect-to-warehouse.md'
        '6-collaboration/checklist.md': 'collaboration/checklist.md'
        '6-collaboration/preset-checks.md': 'collaboration/preset-checks.md'
        '6-collaboration/share.md': 'collaboration/share.md'
        '6-collaboration/invitation.md': 'using-recce/admin-setup.md'
        '7-cicd/setup-cd.md': 'setup-guides/setup-cd.md'
        '7-cicd/setup-ci.md': 'setup-guides/setup-ci.md'
        '7-cicd/ci-cd-getting-started.md': 'setup-guides/environment-setup.md'
        '7-cicd/best-practices-prep-env.md': 'setup-guides/environment-best-practices.md'
        '7-cicd/preset-checks.md': 'collaboration/preset-checks.md'
        '7-cicd/pr-mr-summary.md': 'what-you-can-explore/summary.md'
        '7-cicd/scenario-dev.md': 'using-recce/oss-workflow.md'
        '7-cicd/scenario-pr-review.md': 'using-recce/oss-workflow.md'
        '7-reference/configuration.md': 'technical-concepts/configuration.md'
        '7-reference/state-file.md': 'technical-concepts/state-file.md'
        '7-reference/cli-reference.md': 'using-recce/cli-commands.md'
        '8-technical-concepts/configuration.md': 'technical-concepts/configuration.md'
        '8-technical-concepts/state-file.md': 'technical-concepts/state-file.md'
        '8-community/support.md': 'whats-recce/cloud-vs-oss.md'
        '8-community/changelog.md': 'whats-recce/cloud-vs-oss.md'
  - glightbox:
      skip_classes:
        - skip-glightbox
  - social:
      cards_layout_options:
        background_color: "#2A6CA7"

watch:
  - docs