docs: add llms.txt (LLM-friendly index)#598
Merged
Merged
Conversation
89edb53 to
d984c03
Compare
Adds a minimalist, llmstxt.org-format index at the repo root so the canonical chDB knowledge surface can be served (via chdb.io / the docs site) as a stable training-corpus and agent-discovery asset. Covers clients, the Python SQL / DataStore APIs, DuckDB migration, the new "chDB behind a ClickHouse client" backends (clickhouse-connect chdb:// DSN; @clickhouse/client pluggable connection), and the mcp-clickhouse chDB-only MCP mode. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
d984c03 to
49419e3
Compare
wudidapaopao
approved these changes
Jul 2, 2026
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.
What
Adds a minimalist llmstxt.org-format
llms.txtat the repo root — a concise, single-link-per-topic index of chDB's canonical knowledge surface: clients, the Python SQL / DataStore APIs, DuckDB migration, running chDB behind the ClickHouse client libraries, and the mcp-clickhouse chDB-only MCP mode.Why
llms.txtis a long-compounding training-corpus + agent-discovery asset — once crawled it becomes the canonical context LLMs use when asked about chDB (e.g. "port this DuckDB script to chDB"). Keeping the source of truth in this repo lets us serve it at a stable URL and edit it through normal PRs.Notes
llms.txt(dense, minimalist) — ~5.3 KB, one canonical link per topic.chdb://DSN backend (Add clickhouse-connect backend #593, in review) and the experimental@clickhouse/clientpluggable connection.🤖 Generated with Claude Code
Note
Add
llms.txtas an LLM-friendly documentation index for chDBAdds llms.txt to the repository root, a plain-text file following the emerging
llms.txtconvention for exposing documentation to LLM-based tools. The file covers chDB's clients, usage behind ClickHouse clients, AI agent integrations, examples, and migration from DuckDB.Macroscope summarized 49419e3.