Skip to content

docs: port ClickHouse Agents docs from clickhouse-docs#73

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ea9e18cc
Open

docs: port ClickHouse Agents docs from clickhouse-docs#73
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ea9e18cc

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 27, 2026

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

  • Added 16 Agents pages under products/cloud/features/ai-ml/agents/ (overview, quickstart, chat, prompts, memory, marketplace, sharing-and-access, plus a builder/ subsection covering model parameters, code interpreter, web search, image generation, vision, MCP servers, skills, subagents).
  • Copied all agent-builder screenshots into images/cloud/agent-builder/.
  • Added a new ClickHouse Agents group to the AI/ML section in products/cloud/navigation.json.

Context

  • All slug: values were preserved unchanged from the Docusaurus source so URL mapping between repos stays 1:1.
  • Docusaurus-specific elements were transformed to Mintlify equivalents:
    • @theme/badges/BetaBadge/snippets/components/BetaBadge/BetaBadge.jsx
    • @theme/IdealImage + import x from '@site/static/...'Image snippet referencing /images/... paths
    • <VerticalStepper headerLevel="h3"><Steps> / <Step>
    • :::tip admonitions → <Tip>
    • sidebar_labelsidebarTitle; sidebar_position dropped
  • Internal cross-references use the Mintlify file-path convention (/products/cloud/features/ai-ml/agents/...) rather than the slug, matching the pattern used by sibling pages like ask-ai.mdx.

Notes / ambiguity

  • The source index.md, memory.md, and prompts.md each contained stray \u0001 control 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, preserved slug: values for URL parity). Cross-links use the same file-path style as other Cloud AI/ML docs. products/cloud/navigation.json gains 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ClickHouse-docs 🟢 Ready View Preview May 27, 2026, 11:24 AM

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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";
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a1c21dc. Configure here.

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.

0 participants