docs: link official Native Protocol and Format specs from TCP page#238
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: link official Native Protocol and Format specs from TCP page#238mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
3 tasks
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Ports upstream clickhouse/clickhouse-docs#6425 — replaces the "no formal specification yet" paragraph on the Native (TCP) interface page with links to the official Native Protocol and Native Format specs.
Changes
concepts/features/interfaces/tcp.mdx: dropped the reverse-engineering note, added bullets linking to/interfaces/specs/NativeProtocoland/interfaces/specs/NativeFormat, and added the clickhouse-go example for "language clients".Context
Upstream branch name:
kavirajk/link-official-specs-protocol-format. Onlydocs/integrations/interfaces/tcp.mdchanged substantively in the merge (i18n directories ignored per instructions).Ambiguity / open questions
/interfaces/specs/NativeProtocol,/interfaces/specs/NativeFormat) do not appear to exist either in this Mintlify repo or in the upstream Docusaurus repo at the time of this merge. The upstream PR uses the same root-relative paths, so I've kept them verbatim — they presumably resolve to pages generated/added elsewhere. Worth verifying these resolve before this ships, otherwise the broken-link checker will flag them.es/,ja/,ko/,pt-BR/,ru/,zh/were left untouched per the "ignore i18n" rule.Note
Low Risk
Documentation-only copy and link changes with no runtime impact; verify the new spec URLs resolve to avoid broken links.
Overview
Updates the Native interface (TCP) doc to stop saying there is no formal native protocol spec and instead point readers at the official Native Protocol and Native Format reference pages.
The intro now mentions language clients via clickhouse-go (not only the CLI and inter-server traffic), and adds two bullets that summarize what each spec covers—protocol framing/state machine vs.
Block/column encodings and HTTPFORMAT Native.Reviewed by Cursor Bugbot for commit 62061a1. Bugbot is set up for automated code reviews on this repo. Configure here.