docs: add Troubleshooting and ClickHouse compatibility pages#145
Merged
Conversation
Closes two prod-ready audit findings: - #33 — new guides/troubleshooting.md mapping the common chkit errors (missing deps, auth/connection failures, rejected migrations, blocked destructive ops, checksum mismatch, extra_object drift) to causes and fixes. Error strings taken from the actual source. - #34 — new guides/clickhouse-compatibility.md stating the supported ClickHouse versions (24.x+) and the version-gated features (refreshable MVs 24.10+, set(0) on 26+, uniqueKey Cloud/Shared-only), plus a Requirements section in the CLI README and cross-links from getting-started. Docs-only; verified with `bun run build` in apps/docs (30 pages). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Adds two missing documentation pages from the prod-ready audit (PR I). Documentation-only.
guides/troubleshooting.md) mapping the errors a cold user is most likely to hit — missing@chkit/core,Unknown file extension ".ts", auth failure, connection refused / host not found,Unknown data type family, blocked destructive migration (exit 3), checksum mismatch (exit 1), andextra_objectdrift — each to its cause and fix. Error strings are taken from the actual source so they match what users see.guides/clickhouse-compatibility.md) stating supported versions (24.x+) and the version-gated features (refreshable MVs 24.10+,set(0)on 26+,uniqueKeyCloud/Shared-only). Added a Requirements section to the CLI README and cross-links from getting-started.Test plan
cd apps/docs && bun run build— clean build, 30 pages, sitemap regenerated, both pages present, cross-links resolve.🤖 Generated with Claude Code