Skip to content

docs: update Agent Surfaces doc - #2608

Open
kapunahelewong wants to merge 3 commits into
BuilderIO:mainfrom
kapunahelewong:agent-surfaces
Open

docs: update Agent Surfaces doc#2608
kapunahelewong wants to merge 3 commits into
BuilderIO:mainfrom
kapunahelewong:agent-surfaces

Conversation

@kapunahelewong

Copy link
Copy Markdown
Contributor

What changed

Restructures agent-surfaces.mdx so the detail sections match the order of the "Choose a starting point" table: Rich chat → Native inline UI → Generated inline UI → Full application → Embedded sidecar → Automation-first → Rich chat on your agent.

Specifics

  • Adds two new sections for Native inline UI and Generated inline UI (both were missing entirely)
  • Moves "Full-page Manage Agent" from a top-level section to a ### subsection under Full application, where it belongs
  • Removes the redundant "How to choose" section at the bottom (the table at the top covers it)
  • Adds context prose and a ### How it connects heading before the Embedded sidecar diagram
  • Swaps Key Concepts and Agent Surfaces order in the Overview nav (docsNavItems.ts)

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

builder-io-integration[bot]

This comment was marked as outdated.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Visual recap — screenshot failed

A recap was published, but the PR-comment screenshot could not be captured or uploaded. Open the interactive recap directly:

Open the full interactive recap

Diagnostic:

light: page.screenshot: Timeout 30000ms exceeded. Call log: - taking page screenshot - waiting for fonts to load...

Large diff — this recap is a summarized view (top files + schema/API deltas).

builder-io-integration[bot]

This comment was marked as outdated.

@steve8708

Copy link
Copy Markdown
Contributor

looks great - i may have missed this in the prior PR but we need to make sure the localized versions of any updated docs are updated as well

@builder-io-integration builder-io-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Builder reviewed your changes and found 1 potential issue 🔴

Review Details

Code Review Summary

This incremental update addresses the earlier localization gap by updating all ten localized Agent Surfaces pages and the baseline, while retaining the intended English restructuring and docs-nav reorder. The section order and anchors remain coherent, and the localized pages now include the new inline UI guidance. However, the latest translation commit introduces a high-severity MDX parsing problem in the Traditional Chinese page, and two documentation accuracy issues remain from the previous review. The Traditional Chinese code examples also contain typographic quote characters that readers cannot copy as valid TypeScript. Risk level: Low (documentation/navigation change), although the zh-TW rendering defect is blocking for that locale.

Key findings

  • 🔴 HIGH — zh-TW uses typographic quotes in JSX/HTML component attributes, making the localized MDX invalid.
  • 🟡 MEDIUM — zh-TW code samples use typographic quotes as TypeScript delimiters.
  • 🟡 MEDIUM — Full application documentation still claims “No polling,” despite SSE with polling fallback.
  • 🟡 MEDIUM — Manage Agent is documented as personal-only even though Connections renders both personal and organization MCP servers.

The prior missing-localization issue is resolved in this commit. The docs server is running and ready for browser verification.

🧪 Browser testing: Will run after this review (PR touches UI code)

Comment thread packages/core/docs/content/locales/zh-TW/agent-surfaces.mdx
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.

2 participants