docs: correct CLI docs drift (query JSON, install, filenames, create_database, sidebar)#144
Merged
Merged
Conversation
…database, sidebar) Fixes five documentation-vs-CLI drift findings from the prod-ready audit: - #16 query --json: replace the fictional {command,schemaVersion,rowCount,rows} shape with the real ClickHouse envelope {meta,data,rows,statistics}. - #32 cli/README install: add @chkit/core (schema files import it). - #45 migration filenames: docs used sequential 0001_ names; CLI emits timestamp-prefixed 20260604104251_name.sql. - #46 generate --dryrun --json: document and include the leading create_database operation so operationCount: 2 matches reality. - #47 sidebar: codegen.md and query.md both used order 9; renumber. Docs-only; verified with `bun run build` in apps/docs. 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
Closes five docs↔CLI drift findings from the prod-ready audit (PR H). Documentation-only.
query --json— the documented{command, schemaVersion, rowCount, rows}shape was fictional. Replaced with the real ClickHouse result envelope{meta, data, rows, statistics}(verified live against the cluster), and clarifiedrowsis the count, not the array.cli/README.mdinstall omitted@chkit/core, which schema files import →bun add -d chkit @chkit/core.0001_filenames; the CLI emits timestamp-prefixed20260604104251_name.sql. Updatedgenerate/status/migrateexamples.generate --dryrun --jsonfor a single new table really returnsoperationCount: 2with a leadingcreate_databaseop (risksafe). Documented it and included it in the JSON examples so the count matches.codegen.mdandquery.mdboth usedsidebar.order: 9(undefined nav order). Renumberedquery→ 10,plugin→ 11.Test plan
cd apps/docs && bun run build— clean build, 28 pages, sitemap regenerated, no warnings.query --jsonenvelope captured live against the.env.testcluster to confirm the documented shape.🤖 Generated with Claude Code