docs: align READMEs, llms.txt, and agent files with trust-system positioning#194
Merged
hugocorreia90 merged 2 commits intomainfrom Apr 20, 2026
Merged
docs: align READMEs, llms.txt, and agent files with trust-system positioning#194hugocorreia90 merged 2 commits intomainfrom
hugocorreia90 merged 2 commits intomainfrom
Conversation
…tioning - engine/README.md: lead with trust-system framing; add ELT scope table, seven trust dimensions section, and Branches / Cost / Observability / Portability rows in the features table. - README.md (monorepo root): one-liner now leads with "trust system for your data" + "Keep Databricks or Snowflake, bring Rocky for the DAG." - docs/public/llms.txt: replace the "owns the T" positioning and add explicit ELT scope bullets so LLM-crawlers pick up the accurate coverage (rocky load, bronze replication). - CLAUDE.md (root), engine/AGENTS.md: one-line wording fixes so future agent guidance doesn't carry the stale "replaces dbt" frame. All changes are pure copy; no code or feature changes. Docs build still passes (69 pages, 1.68s).
The fixture version strings and the dagster-rocky wheel-version in uv.lock still reflected engine-v1.10.0 / dagster-v1.6.0 from before the coordinated 1.11.0 / 1.7.0 release (PRs #188, #189). Regenerated via `just regen-fixtures` and `just codegen`; the 35 fixture diffs are pure `version` string bumps with no shape changes. Unblocks the codegen-drift CI check on PR #194.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #193. Propagates the trust-system positioning from the intro page across the rest of the repo's high-visibility markdown.
engine/README.md— lead with trust-system framing; add the ELT scope table, seven trust dimensions section, and Branches / Cost / Observability / Portability rows in the features table.README.md(monorepo root) — one-liner now reads "The trust system for your data. … Keep Databricks or Snowflake. Bring Rocky for the DAG." instead of the generic "SQL transformation engine" line.docs/public/llms.txt— replace the "owns the T" positioning and add explicit ELT scope bullets so LLM-crawlers pick up the accurate coverage (rocky load, bronze replication).CLAUDE.md(root) andengine/AGENTS.md— one-line wording fixes so future agent guidance doesn't carry the stale "replaces dbt" frame.All changes are pure copy; no code or feature changes.
Why now
Launch-prep: ensures the GitHub landing page, engine README, and LLM-visible positioning all align with the intro (#193). Avoids the "you say trust system in one place and 'replaces dbt' in another" credibility hit on launch day.
Test plan
npm run buildindocs/passes — 69 pages, 1.68s, no errors (llms.txt is a static asset so build is just a safety check)engine/README.mdon GitHub shows the ELT scope table + seven trust dimensions cleanly (no broken emoji / table glyphs)rocky loadcoverage)