docs: vendor ClickHouse documentation - #728
Open
Blargian wants to merge 2 commits into
Open
Conversation
Make dbt-clickhouse the source of truth for its public documentation, verify it against the ClickHouse docs site, and synchronize it back through an automated pull request. Related: ClickHouse/ClickHouse#116357
Place the ClickHouse documentation directly in the existing docs directory and update verification, synchronization, and contributor references to use that path. Related: #728
This was referenced Aug 28, 2026
Blargian
marked this pull request as ready for review
September 1, 2026 14:50
Member
Author
|
How it works:
|
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
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
Make
ClickHouse/dbt-clickhousethe source of truth for its public ClickHouse documentation.ClickHouse/ClickHouseintodocs, including repository-owned navigation.ClickHouse/ClickHouseafter releases, manual dispatches, or merged pull requests carrying thesync-docslabel.The published documentation URLs remain unchanged. Package behavior is unaffected, so no changelog entry is needed.
Related: ClickHouse/ClickHouse#116357
Related: ClickHouse/ClickHouse#116726
This draft depends on a companion
ClickHouse/ClickHousechange that replaces the inline dbt sidebar definition with a reference todata-ingestion/etl-tools/dbt/navigation.json. After that change merges,CLICKHOUSE_DOCS_REFmust be updated to its merge commit before this pull request is merged.Validation:
actionlint,yamllint, scoped Mintlify validation, navigation coverage, and 84,162 internal link and anchor checks passed with zero errors.Checklist
docswas updated with further explanations or tutorials