docs: keep the root README focused on CLI behavior - #975
Merged
Merged
Conversation
sdairs
added this pull request to stack #876
September 16, 2026 11:27
This was referenced Sep 16, 2026
All 58 direct and cumulative stack merges succeed, but GitHub retains an unknown result and a test-merge ref from older branch heads. Trigger a fresh calculation without changing the source tree.
Carry existing lower-stack README corrections and ancestry forward. The merged tree matches the independently verified cumulative stack result.
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.
Keep the root README focused on
clickhousectl: move Rust settings types, UDF error/model details, and OpenAPI analyzer documentation intocrates/clickhouse-cloud-api/README.md, while retaining CLI input/output behavior. Clarify both AGENTS.md files and the completion checklist so library-only changes do not require a root README edit.Appended after #973 at the top of native stack #876. The branch also includes the documentation corrections already pushed to #897, #940, #944, #945, and #947, so the combined stack head contains the complete cleanup. Relative to #973, only the two READMEs and two AGENTS.md files change.
Audited main and all 58 previously open PRs. The five PRs above were the only ones adding library-only root README content. PR #940 retains its TTL note because the CLI accepts that input.
Validation: formatting and whitespace checks passed after stacking. The final tree exactly matches the previously audited merge simulation of all 56 stack entries plus the cleanup; all existing stack heads are ancestors of this branch. The original main-based cleanup passed default CLI Clippy/tests, telemetry-disabled check and all-target Clippy, library/analyzer all-target Clippy/tests, and 91 Python tests. Stacking introduces no runtime-code changes relative to #973.
Fixes #974.