Skip to content

Commit c44b34a

Browse files
authored
Merge pull request #99 from DataRecce/feature/drc-3415-agent-readiness-docs-llms
feat(llms): publish llms.txt on docs.reccehq.com
2 parents a884da2 + 6ce1843 commit c44b34a

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

docs/llms.txt

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Recce Docs
2+
3+
> Recce is a Data Review Agent that validates dbt pull requests before merge. The docs cover Recce Cloud (managed) and Recce OSS (local CLI), with guides for connecting Git and warehouses, running data diffing and column-level lineage, collaborating on checklists, and wiring CI/CD. Use this index to find the right page in one request.
4+
5+
## What's Recce
6+
7+
- [Recce: Data Review Agent for dbt Pull Requests](https://docs.reccehq.com/): product overview and what Recce validates between environments
8+
- [Cloud vs Open Source](https://docs.reccehq.com/whats-recce/cloud-vs-oss/): compare Recce Cloud and Recce OSS to pick the right fit
9+
10+
## Getting Started
11+
12+
- [Get Started with Recce Cloud](https://docs.reccehq.com/getting-started/start-free-with-cloud/): set up Recce Cloud to automate dbt validation on pull requests
13+
- [OSS Setup](https://docs.reccehq.com/getting-started/oss-setup/): install and run Recce OSS locally for manual dbt validation
14+
- [Jaffle Shop Tutorial (OSS)](https://docs.reccehq.com/getting-started/jaffle-shop-tutorial/): hands-on walkthrough using the Jaffle Shop sample dbt project
15+
16+
## Setup Guides
17+
18+
- [Connect Your Repository](https://docs.reccehq.com/setup-guides/connect-git/): connect GitHub or GitLab to Recce Cloud
19+
- [Connect Data Warehouse](https://docs.reccehq.com/setup-guides/connect-to-warehouse/): connect Snowflake, Databricks, BigQuery, or Redshift
20+
- [Environment Setup](https://docs.reccehq.com/setup-guides/environment-setup/): configure dbt profiles and CI/CD variables for base vs current comparison
21+
- [Environment Best Practices](https://docs.reccehq.com/setup-guides/environment-best-practices/): reliable patterns for shared production base and per-PR schemas
22+
- [Advanced Environment Setup](https://docs.reccehq.com/setup-guides/environment-advanced/): build a session base per PR to silence false alarms from non-deterministic SQL
23+
- [dbt Cloud Setup](https://docs.reccehq.com/setup-guides/dbt-cloud-setup/): integrate Recce with dbt Cloud artifacts
24+
- [Setup CD](https://docs.reccehq.com/setup-guides/setup-cd/): automate baseline updates after every merge to main
25+
- [Setup CI](https://docs.reccehq.com/setup-guides/setup-ci/): validate dbt data changes on every pull request
26+
- [Claude Plugin](https://docs.reccehq.com/setup-guides/claude-plugin/): use Recce inside Claude Code with automated MCP and artifact setup
27+
- [MCP Server (AI Agents)](https://docs.reccehq.com/setup-guides/mcp-server/): connect Claude Code, Cursor, or Windsurf to validate data via natural language
28+
29+
## Using Recce
30+
31+
- [Admin Setup](https://docs.reccehq.com/using-recce/admin-setup/): configure your Recce Cloud organization, projects, and members
32+
- [Data Developer Workflow](https://docs.reccehq.com/using-recce/data-developer/): validate dbt changes through the development lifecycle
33+
- [Data Reviewer Workflow](https://docs.reccehq.com/using-recce/data-reviewer/): review and approve dbt data changes on pull requests
34+
- [CLI Commands](https://docs.reccehq.com/using-recce/cli-commands/): command-line reference for Recce Cloud and Recce OSS
35+
- [Workflow in OSS](https://docs.reccehq.com/using-recce/oss-workflow/): local OSS workflow for state files, checklists, and sharing results
36+
37+
## What You Can Explore
38+
39+
- [Data Review Summary](https://docs.reccehq.com/what-you-can-explore/summary/): AI-generated pull request summary that explains the change and its impact
40+
- [Lineage Diff](https://docs.reccehq.com/what-you-can-explore/lineage-diff/): visualize added, modified, and removed models between base and current
41+
- [Code Change](https://docs.reccehq.com/what-you-can-explore/code-change/): inspect SQL and config diffs for each changed model
42+
- [Column-Level Lineage](https://docs.reccehq.com/what-you-can-explore/column-level-lineage/): trace upstream and downstream relationships at the column level
43+
- [Impact Radius](https://docs.reccehq.com/what-you-can-explore/impact-radius/): identify downstream models and columns affected by a change
44+
- [Breaking Change Analysis](https://docs.reccehq.com/what-you-can-explore/breaking-change-analysis/): categorize modified models as breaking, non-breaking, or partial
45+
- [Data Diffing](https://docs.reccehq.com/what-you-can-explore/data-diffing/): row count diff, profile diff, value diff, top-K diff, histogram diff, and query
46+
- [Multi-Models](https://docs.reccehq.com/what-you-can-explore/multi-models/): run checks across multiple models at once
47+
48+
## Collaboration
49+
50+
- [Checklist](https://docs.reccehq.com/collaboration/checklist/): save validation checks as proof-of-correctness for the PR
51+
- [Activity](https://docs.reccehq.com/collaboration/activity/): audit trail of approvals, comments, and edits per check
52+
- [Preset Checks](https://docs.reccehq.com/collaboration/preset-checks/): turn recurring checks into defaults for every PR
53+
- [Share](https://docs.reccehq.com/collaboration/share/): share validation results securely with reviewers and stakeholders
54+
55+
## Reference
56+
57+
- [Configuration](https://docs.reccehq.com/technical-concepts/configuration/): recce.yml reference for preset checks and parameters
58+
- [State File](https://docs.reccehq.com/technical-concepts/state-file/): state file format for validation results, checks, and environment info

0 commit comments

Comments
 (0)