Skip to content

docs: rewrite opening sentences of three pages to say what they give - #726

Merged
zlareb1 merged 1 commit into
ClickHouse:mainfrom
sharmis-tp:fix/721-page-opening-sentences
Nov 16, 2026
Merged

zlareb1 merged 1 commit into
ClickHouse:mainfrom
sharmis-tp:fix/721-page-opening-sentences

Conversation

@sharmis-tp

Copy link
Copy Markdown
Contributor

Summary

  • Rewrote the opening sentence of three doc pages so the first sentence says what the page gives, not only what it requires
  • Updated llms.txt entries to match the new first sentences
  • llms.txt was updated by hand because docs_reference.py needs Python 3.12+; CI should regenerate it

grep-shim.md

Before: "Needs Node 18 or later, a viewer token, and a repository in the code index."
After: "The grep shim is a grep/rg wrapper that appends each hit's enclosing function, from the code index, to the match line; it needs Node 18 or later, a viewer token and a repository in the code index."

integrations/index.md

Before: "Loom on a bare ClickHouse service is a complete deployment."
After: "Integrations put Loom's tools in front of a model, capture its conversations, or receive its telemetry."

code-index-operations.md

Before: "The code index runs only when an operator enables its workers and configures repositories."
After: "This page covers how to enable the code index workers, configure repositories and keep the index current; the code index runs only when an operator enables its workers and configures repositories."

Rebase note

#688 edits llms.txt and #695 edits integrations/index.md. This PR changes the opening paragraph of integrations/index.md (above the table #695 adds a row to) and three llms.txt entries. No conflict expected, but rebasing after either lands may be needed.

Fixes #721

Signed-off-by: sharmis-tp <sharmis.tp@gmail.com>
@zlareb1 zlareb1 self-assigned this Nov 16, 2026
@zlareb1
zlareb1 merged commit ce66160 into ClickHouse:main Nov 16, 2026
44 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.

docs: three pages open with a sentence that does not say what the page gives

2 participants