docs: llms.txt fixes, link-check CI, and generated llms-full.txt#599
Merged
Merged
Conversation
…s.txt - Point the DuckDB migration entry at the runnable cookbook (migration analyzer + 18-query benchmark) instead of the not yet published docs guide URL, which returned 404. - Add the OTEL ingestion buffer cookbook entry: Node.js moves OTEL/LLM-trace data from S3 into ClickHouse with a single SQL statement, without rows passing through the JS heap. - Note that clickhouse.com/docs pages serve Markdown via 'Accept: text/markdown', so agents can skip HTML parsing. Co-Authored-By: Claude Fable 5 <[email protected]>
- llms-txt-check workflow (PR + weekly): every llms.txt link must resolve (404/410 fail the job), and a coverage diff against the auto-generated clickhouse.com/docs/llms.txt reports docs pages missing from the curated index and vice versa. - scripts/generate_llms_full.py builds llms-full.txt from the 44 docs/chdb pages in ClickHouse/clickhouse-docs plus ARCHITECTURE.md and the Node.js/Bun/Go/Rust binding READMEs, each block carrying a '**URL:**' provenance line. - Commit the generated llms-full.txt (~500 KB, ~125k tokens): the whole corpus fits in a single model context window. Co-Authored-By: Claude Fable 5 <[email protected]>
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
Three follow-ups to the llms.txt added in #598:
1.
llms.txtcontent fixesmigration-from-duckdb— with the static API analyzer and the 18-query benchmark.otel-ingestion-buffer: a Node.js service moves OTEL/LLM-trace data from S3 into ClickHouse with a single SQL statement, without rows ever passing through the JS heap.clickhouse.com/docsserve clean Markdown viaAccept: text/markdown, so agents can skip HTML parsing.2. CI:
.github/workflows/llms-txt-check.ymlRuns on PRs touching the llms files and weekly:
llms.txtmust resolve; 404/410 fail the job (with retries; 403/429 rate limits only warn).clickhouse.com/docs/llms.txtand writes both directions to the job summary — published docs pages missing from the curated index (curation candidates), and curated links missing from the docs index (rename/unpublish warnings).3.
llms-full.txt+ generatorscripts/generate_llms_full.py(stdlib only) builds the full-corpus companion file that the llms.txt convention pairs with an index:docs/chdbpages from ClickHouse/clickhouse-docs, ordered getting-started → install → api → datastore → guides → configuration → debugging → reference,docs/ARCHITECTURE.mdand the Node.js / Bun / Go / Rust binding READMEs,**URL:**provenance line so RAG chunks keep their source.The generated
llms-full.txtis committed: ~500 KB ≈ 125k tokens, so the whole chDB corpus fits in a single model context window.Verification
llms.txtchecked: every one returns HTTP 200.🤖 Generated with Claude Code
Note
Add llms-full.txt generation script, CI link-check workflow, and llms.txt fixes
llms.txtreturns HTTP 404/410 after retries, and posts a coverage diff between curated links and the live docs index to the job summary without affecting pass/fail.Accept: text/markdownfor docs pages.Macroscope summarized 64e6ba6.