Skip to content

Agent Docs - Iterate#6288

Open
dhtclk wants to merge 4 commits into
mainfrom
improve-agent-docs
Open

Agent Docs - Iterate#6288
dhtclk wants to merge 4 commits into
mainfrom
improve-agent-docs

Conversation

@dhtclk
Copy link
Copy Markdown
Collaborator

@dhtclk dhtclk commented May 26, 2026

Summary

Follow up PR for #6281
Iterating on docs to get them up to par on quality after the initial pass. Primarily adding screenshots for this pass to start.

Resolves DOC-786

Checklist


Note

Low Risk
Documentation-only changes with no runtime impact; verify screenshot assets exist and fix the broken Memory intro if present.

Overview
This PR iterates on ClickHouse Agents cloud docs (follow-up to the initial Agent Builder pass): it aligns prose with the current console UI, adds screenshots (IdealImage) for key flows, and tightens section structure.

Structure and navigation: The Agent Builder overview is now a landing page (doc_type: landing-page) with a page table and a quickstart tip, instead of long inline sections on identity and configuration. The agents overview and in this section lists use tables for skimmability.

Quickstart: Rebuilt as a VerticalStepper flow—launch from the service sidebar, create agent fields (including Category), then split Capabilities (Run Code, Web Search, MCP, Skills, etc.) vs Add Tools (third-party/image integrations), with step images through a sample query.

Product accuracy: Docs now distinguish Capabilities vs Add Tools—e.g. Run Code / Web Search toggles vs image generation via the tools modal; vision via composer Upload to Provider; sharing via the builder share icon/modal; memory and prompts tied to left-nav panels. Model parameters gains console open steps and is marked draft: true.

UX polish: Chat, marketplace, memory, and prompts pages add step-by-step UI guidance and screenshots (fork modes, multi-conversation, share link, marketplace actions, memory CRUD, prompt preview/use). Minor list punctuation normalized (em dashes to hyphens in several builder pages).

Note for reviewers: memory.md opens with a sentence that appears to drop the word Memory (“is a per-user store…”)—likely an accidental edit worth fixing before merge.

Reviewed by Cursor Bugbot for commit bec64dc. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment May 28, 2026 1:05am
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored May 28, 2026 1:05am
clickhouse-docs-ko Ignored Ignored Preview May 28, 2026 1:05am
clickhouse-docs-ru Ignored Ignored Preview May 28, 2026 1:05am
clickhouse-docs-zh Ignored Ignored Preview May 28, 2026 1:05am

Request Review

@dhtclk dhtclk changed the title Added screenshots and tweaked docs based on current UI Agent Docs - Iterate May 26, 2026
@dhtclk dhtclk requested review from Blargian and graphaelli May 26, 2026 23:16
- **Max Context Tokens** caps total context the agent sends to the model. Leave as **System** to use the model's default. Lower it to reduce cost; raise it for agents that need to reason over large inputs.
- **Max Output Tokens** caps the size of the agent's response. **System** uses the model's default. Set lower if responses are too long, higher if they're being cut off.
- **File Token Limit** caps how many tokens a single uploaded file contributes to context. Useful when users attach large files and you don't want them to crowd out the rest of the conversation.
- **Max Context Tokens** - caps total context the agent sends to the model. Leave as **System** to use the model's default. Lower it to reduce cost; raise it for agents that need to reason over large inputs.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't see this when I try the model builder, is this just not available in the Open House demo?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, this is only available for certain models, none of which are enabled in production yet. I'm ok to remove this and add back when those are available.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I've added draft=true to the frontmatter of this doc so that it doesn't show in production. When these features are available in production we'll just need to remove that attribute and add it to the overview page again.

- **Temperature** randomness. Higher values (0.7–1.0) = more random, while lower values (0.0–0.3) = more focused and deterministic. We recommend altering this or Top P but not both.
- **Top P** nucleus sampling. Changes how the model selects tokens for output.
- **Top K** restricts sampling to the top K most likely tokens at each step. Supported by some providers; controls determinism along a different axis than temperature.
- **Temperature** - randomness. Higher values (0.7–1.0) = more random, while lower values (0.0–0.3) = more focused and deterministic. We recommend altering this or Top P but not both.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same here

@Blargian Blargian marked this pull request as ready for review May 27, 2026 10:45
@Blargian Blargian requested a review from a team as a code owner May 27, 2026 10:45
Copy link
Copy Markdown
Member

@Blargian Blargian left a comment

Choose a reason for hiding this comment

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

LGTM, let's wait for any additional feedback from @graphaelli

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 27, 2026

Docs PR opened: ClickHouse/mintlify-docs-dev#73

Ported ClickHouse Agents documentation (16 pages plus screenshots) from the upstream clickhouse-docs repo into the Mintlify AI/ML section.

Copy link
Copy Markdown
Member

@graphaelli graphaelli left a comment

Choose a reason for hiding this comment

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

thanks, great updates

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 3 potential issues.

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 fefa2d2. Configure here.

Comment thread docs/cloud/features/10_AI_ML/agents/builder/index.md Outdated
Comment thread docs/cloud/features/10_AI_ML/agents/memory.md Outdated
Comment thread docs/cloud/features/10_AI_ML/agents/prompts.md Outdated
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.

3 participants