Skip to content

docs: add llms.txt (LLM-friendly index)#598

Merged
wudidapaopao merged 1 commit into
chdb-io:mainfrom
ShawnChen-Sirius:docs/llms-txt
Jul 2, 2026
Merged

docs: add llms.txt (LLM-friendly index)#598
wudidapaopao merged 1 commit into
chdb-io:mainfrom
ShawnChen-Sirius:docs/llms-txt

Conversation

@ShawnChen-Sirius

@ShawnChen-Sirius ShawnChen-Sirius commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What

Adds a minimalist llmstxt.org-format llms.txt at 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.txt is 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

  • Style follows DuckDB's llms.txt (dense, minimalist) — ~5.3 KB, one canonical link per topic.
  • New "Use chDB behind a ClickHouse client" section documents the clickhouse-connect chdb:// DSN backend (Add clickhouse-connect backend #593, in review) and the experimental @clickhouse/client pluggable connection.
  • Root placement is intentional: it yields a stable raw URL for downstream hosting/proxying and matches the llms.txt root convention.

🤖 Generated with Claude Code

Note

Add llms.txt as an LLM-friendly documentation index for chDB

Adds llms.txt to the repository root, a plain-text file following the emerging llms.txt convention 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.

@ShawnChen-Sirius ShawnChen-Sirius force-pushed the docs/llms-txt branch 2 times, most recently from 89edb53 to d984c03 Compare July 2, 2026 04:48
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]>
@wudidapaopao wudidapaopao merged commit 47b23f4 into chdb-io:main Jul 2, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants