docs: port ClickHouse Agents docs from clickhouse-docs#73
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit a1c21dc. Configure here.
| --- | ||
|
|
||
| import BetaBadge from "/snippets/components/BetaBadge/BetaBadge.jsx"; | ||
| import { Image } from "/snippets/components/Image.jsx"; |
There was a problem hiding this comment.
Unused Image import in builder overview page
Low Severity
The { Image } component is imported from /snippets/components/Image.jsx but is never used anywhere in the page — the file only contains a <BetaBadge/>, a <Tip>, and a Markdown table. The other builder pages that don't use images (e.g. mcp-servers.mdx, model-parameters.mdx, skills.mdx, subagents.mdx) correctly omit this import.
Reviewed by Cursor Bugbot for commit a1c21dc. Configure here.
Summary
Ports the ClickHouse Agents documentation from upstream PRs #6288 (the trigger) and its base #6281 (which had not been migrated yet) into the Mintlify site.
Changes
products/cloud/features/ai-ml/agents/(overview, quickstart, chat, prompts, memory, marketplace, sharing-and-access, plus abuilder/subsection covering model parameters, code interpreter, web search, image generation, vision, MCP servers, skills, subagents).images/cloud/agent-builder/.ClickHouse Agentsgroup to the AI/ML section inproducts/cloud/navigation.json.Context
slug:values were preserved unchanged from the Docusaurus source so URL mapping between repos stays 1:1.@theme/badges/BetaBadge→/snippets/components/BetaBadge/BetaBadge.jsx@theme/IdealImage+import x from '@site/static/...'→Imagesnippet referencing/images/...paths<VerticalStepper headerLevel="h3">→<Steps>/<Step>:::tipadmonitions →<Tip>sidebar_label→sidebarTitle;sidebar_positiondropped/products/cloud/features/ai-ml/agents/...) rather than the slug, matching the pattern used by sibling pages likeask-ai.mdx.Notes / ambiguity
index.md,memory.md, andprompts.mdeach contained stray\u0001control characters that broke a sentence ("share your agents…", "Memory is a per-user store…", "Open the Prompts panel…"). I removed the control bytes and reconstructed the sentences from context; please verify the wording.Note
Low Risk
Documentation and navigation-only changes with no application or security logic; main review focus is link accuracy and the manually fixed sentences after control-character cleanup.
Overview
This PR ports the ClickHouse Agents documentation from upstream Docusaurus into the Mintlify site: 16 new pages under
products/cloud/features/ai-ml/agents/(overview, quickstart, chat, prompts, memory, marketplace, sharing/access, plus an Agent Builder subsection for model parameters, code interpreter, web search, image generation, vision, MCP, skills, and subagents).Content is adapted to Mintlify patterns (BetaBadge, Image snippets, Steps/Tip,
sidebarTitle, preservedslug:values for URL parity). Cross-links use the same file-path style as other Cloud AI/ML docs.products/cloud/navigation.jsongains a nested ClickHouse Agents group under AI/ML so the section appears in the sidebar.A few sentences were reconstructed after removing stray control characters from the source (
index,memory,prompts); worth a quick editorial pass on those lines.Reviewed by Cursor Bugbot for commit a1c21dc. Bugbot is set up for automated code reviews on this repo. Configure here.