docs: Update docs with latest examples#742
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
📝 WalkthroughWalkthroughThe pull request expands the documentation examples section with multiple new use-case scenarios, each featuring specific dbt, lineage, migration, and governance workflows. User prompts, demo images, and descriptions are added for each case, increasing the showcase content without modifying or removing existing examples. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/docs/examples/index.md (1)
89-89: Standardize Fabric product naming across tags.Tags mix
MS FabricandMicrosoft Fabric. Pick one canonical label to improve consistency/filtering across the docs.Also applies to: 105-105
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/examples/index.md` at line 89, The tags line contains mixed labels (`MS Fabric` and `Microsoft Fabric`); choose one canonical tag (e.g., replace all occurrences of `MS Fabric` with `Microsoft Fabric` or vice versa) and update every tag instance in this file (the inline tag list like `MS SQL Server` `MS Fabric` `dbt` `Migration` `data-diff`) and the other occurrence mentioned (the second tag line) so tags are consistent across the docs; ensure spacing/backticks around each tag remain unchanged when replacing the token.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/examples/index.md`:
- Line 15: Replace the phrase "anti patterns" in the example sentence "Run
quality checks and grading on the mart layer queries of my dbt project to find
out the SQL anti patterns." with the hyphenated form "anti-patterns" so the
sentence reads "...to find out the SQL anti-patterns."; update the exact string
in the docs example (the sentence at Line 15) to maintain correct terminology.
---
Nitpick comments:
In `@docs/docs/examples/index.md`:
- Line 89: The tags line contains mixed labels (`MS Fabric` and `Microsoft
Fabric`); choose one canonical tag (e.g., replace all occurrences of `MS Fabric`
with `Microsoft Fabric` or vice versa) and update every tag instance in this
file (the inline tag list like `MS SQL Server` `MS Fabric` `dbt` `Migration`
`data-diff`) and the other occurrence mentioned (the second tag line) so tags
are consistent across the docs; ensure spacing/backticks around each tag remain
unchanged when replacing the token.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: fd559399-630c-44d7-9737-2b8f1aceda6a
⛔ Files ignored due to path filters (7)
docs/docs/assets/images/demo_column_lineage_diff.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_fabric_platform_admin.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_idea_to_production.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_mssql_to_fabric.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_onboarding_peer_review.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_refactor_dbt.jpgis excluded by!**/*.jpgdocs/docs/assets/images/demo_upstream_schema_change.jpgis excluded by!**/*.jpg
📒 Files selected for processing (1)
docs/docs/examples/index.md
|
|
||
| **Prompt:** | ||
|
|
||
| > Run quality checks and grading on the mart layer queries of my dbt project to find out the SQL anti patterns. Also fix those issues, validate and re-grade them. |
There was a problem hiding this comment.
Fix hyphenation in SQL term at Line 15.
Use “anti-patterns” instead of “anti patterns” to keep terminology correct and consistent.
🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: Use a hyphen to join words.
Context: ... my dbt project to find out the SQL anti patterns. Also fix those issues, validat...
(QB_NEW_EN_HYPHEN)
[style] ~15-~15: Consider using a different verb for a more formal wording.
Context: ...to find out the SQL anti patterns. Also fix those issues, validate and re-grade the...
(FIX_RESOLVE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/examples/index.md` at line 15, Replace the phrase "anti patterns"
in the example sentence "Run quality checks and grading on the mart layer
queries of my dbt project to find out the SQL anti patterns." with the
hyphenated form "anti-patterns" so the sentence reads "...to find out the SQL
anti-patterns."; update the exact string in the docs example (the sentence at
Line 15) to maintain correct terminology.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
yukthagv
left a comment
yukthagv
left a comment
There was a problem hiding this comment.
other than the nitpicks bot has picked(very minor can be ignored), everything looks good
|
|
||
| `dbt` `SQL Quality` `A-F Grading` | ||
|
|
||
| A junior engineer always gets senior-level peer review — altimate grades the mart layer, flags every anti-pattern, fixes the offending SQL, and re-grades to prove the improvement. |
There was a problem hiding this comment.
@arora-saurabh448 can we please change this to:
A senior engineer has to always review a junior engineers work— Altimate Code grades the code, flags every anti-pattern, fixes the offending SQL, and re-grades to prove the improvement.
|
|
||
| `dbt` `Lineage` `Incident Response` | ||
|
|
||
| A staging model renames a column and the dbt run fails. altimate reads the error log, traces lineage, pinpoints every broken downstream model, and fixes the references — no hunting through dozens of files. |
There was a problem hiding this comment.
@arora-saurabh448
A column in staging model was renamed and now the dbt run fails. Altimate Code reads the error log, traces lineage, pinpoints every broken downstream model, and fixes the references — no hunting through dozens of files.
|
|
||
| `MS Fabric` `Governance` `Lineage` `PII Audit` | ||
|
|
||
| Drop altimate into an unfamiliar Fabric instance and get an immediate picture — lineage, code quality, active roles, users, PII exposures — in one prompt. |
There was a problem hiding this comment.
@arora-saurabh448
Drop Altimate Code into an unfamiliar Fabric instance and get an immediate picture — lineage, code quality, active roles, users, PII exposures — in one prompt.
Patch release. User-facing: BigQuery finops tools were 100%-broken and are now fixed, and work in any BigQuery region (previously hardcoded to US). Changes since v0.6.0: - fix: BigQuery finops SQL — correct INFORMATION_SCHEMA columns + multi-region support (#739, closes #738). `error_message`/`error_code`/`total_rows` bugs plus `state='SUCCESS'` vs BQ's actual `'DONE'` (every completed job was being reported as FAILED). All 5 finops modules now read the BQ connection's `location` via a sanitised `{region}` placeholder. - fix: make anti-slop workflow advisory instead of auto-closing legitimate PRs (#741, closes #740). - fix: marker-guard hotfix for isValidDatabricksHost env-fallback path. - docs: 12 end-to-end showcase examples + `location` documented for BQ (#742). Review: 5-persona review (CTO/PM/DE/Tech Lead/Chaos Gremlin) ran on main — no P0s, no HOLDs. 1 P1 (silent `us` fallback compliance concern — addressed via docs + changelog warnings; behaviour-change follow-ups tracked in #754). 2 HIGH docs-accuracy items fixed pre-tag: `location` row in drivers.md and finops-tools.md. Tests: - 47 new adversarial tests in test/skill/release-v0.6.1-adversarial.test.ts (sanitizeBqRegion injection vectors, interpolateBqRegion idempotency, bqRegionFor registry edge cases, BIGQUERY_HISTORY_SQL column-name regression guards for all four #739 bugs, cross-module {region} guard, buildHistoryQuery full-pipeline incl. Snowflake/Databricks no-regression). - 409/409 tests pass across finops + skill suites. Full altimate suite previously green (2917/2917) on #739 merge. - Typecheck: 5/5 pass. Marker guard: clean. Pre-release sanity: all 4 green. Deferred: BQ finops UX + robustness follow-ups filed as #754 (surface queried region in responses, distinguish no-location vs invalid-location, warn at warehouse_add time, friendlier perms error, options-object refactor, e2e silent-skip warning). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3 participants
Summary
What changed and why?
Test Plan
How was this tested?
Checklist
Summary by CodeRabbit
Summary by cubic
Updated docs with seven new end-to-end examples and linked demos, plus added images. Scenarios include
dbtquality grading and fixes, upstream schema incident triage, column-level lineage diff for PR review, model scaffolding to production, safe refactors with impact analysis, MS SQL Server → Microsoft Fabric migration viadbt, and a Fabric admin overview.Written for commit 17a3acf. Summary will update on new commits.