docs: reorganize docs/ and sync materialization flow diagrams with macros - #1627
Merged
Conversation
…cros Restructure docs/ into flow/ (architecture) and guides/ (tutorials): - Move the 5 flow diagrams into docs/flow/ and the 4 how-to guides into docs/guides/ (history preserved via rename). - Add docs/README.md (index) and docs/flow/README.md, which explains the use_materialization_v2 behavior flag that selects the V1/V2 diagrams. - Add flow docs for snapshot, streaming table, and materialized view. - Stamp every doc with a "Last updated" date. Sync the flow diagrams with the current macros (targeted fixes only): - seed V2: drop the transaction split, COMMIT, and index creation that create_seed_v2 no longer performs; split the view/MV vs streaming-table errors. seed V1: gate index creation on first-run/full-refresh. - table V2 and incremental "New": remove the fabricated up-front staging cleanup node. - incremental "New": reorder the config-change steps to match apply_config_changeset (tags, tblproperties, liquid, comments, constraints). - incremental "Existing": gate liquid clustering inside the config-change branch, matching the macro. Wire the flow docs into AGENTS.md with a "keep docs in sync, code is the source of truth" note. Fix drift outside docs/: README's broken databricks-workflows.md link and moved guide paths, CONTRIBUTING's tox->hatch commands, and the Python 3.9->3.10 floor.
sd-db
marked this pull request as ready for review
August 9, 2026 12:07
jprakash-db
approved these changes
Aug 10, 2026
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
2 participants
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.
Description
Reorganizes
docs/and brings the materialization flow diagrams back in sync with the current macros.Structure
docs/intodocs/flow/(architecture — the materialization flow diagrams) anddocs/guides/(user-facing how-tos), keepingdbt-databricks-dev.md,testing.md, anddbr-capability-system.mdat the top level. Moves preserve history.docs/README.md(index) anddocs/flow/README.md, which explains theuse_materialization_v2behavior flag (defaults toFalse) that selects between the V1 and V2 diagrams._Last updated:_stamp.Flow-diagram sync (targeted fixes, verified against the macros)
COMMIT/ index creation thatcreate_seed_v2no longer performs; split the view/MV vs streaming-table compiler errors. seed V1: gated index creation on first-run/full-refresh (seeds.sql).apply_config_changeset(tags → tblproperties → liquid → comments → constraints).table V1,view V1/V2,replace,snapshot,streaming_table,materialized_view: verified accurate, unchanged.Docs wiring & drift fixes
AGENTS.mdwith a "keep docs in sync, code is the source of truth" note.README.mdlink todatabricks-workflows.md(+ moved guide paths), updatedCONTRIBUTING.MDtox→hatchcommands, and reconciled the Python3.9→3.10floor.Testing
Docs-only — no runtime impact. All 8 flow docs' Mermaid diagrams render via
mermaid-cli(13 charts); internal links resolve;pre-commit run --all-filespasses.