docs: update agent chart contract - #158
Conversation
👷 Deploy request for redpanda-agentic-data-plane pending review.Visit the deploys page to approve it
|
- Name the Agentic Data Plane chart contract instead of "current" - Restore title case in the page title to match the nav entry - Reduce learning objectives to three - Document title precedence and the default series labels - Match the Inspector walkthrough and image description to the screenshot - Reword the unsupported-type symptom to match the single error surface - Spell out numbers in prose Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
|
Thanks for this. I pushed 9ad93f7 with follow-up edits rather than leaving more suggestions, since several of my earlier ones had gone stale against your latest commit. The chart contract itself checks out. Verified against the renderer: the JSON schema, the bar and line restriction, the top-level What Claude changed, and why: Terminology. The page now says Agentic Data Plane instead of Redpanda Cloud. Agentic Data Plane runs standalone at ai.redpanda.com, and the Inspector and its chart components belong to it, so framing this as a Cloud dependency isn't right. This also replaces "the current chart contract" with "the Agentic Data Plane chart contract". Naming it keeps the page accurate the next time the contract changes, where "current" would quietly go stale. Page title. Restored to title case, "Draw Charts from an Agent". Our style guide uses sentence case for H2 and below only; page titles stay title case, and the nav entry already read "Draw Charts from an Agent". Learning objectives. Reduced from four to three, which is our maximum. "Emit a chart code block" is folded into the instruct objective. Troubleshooting table. "Unsupported chart type" is the description inside the Failed to render chart error rather than a separate error, so that row is reworded. The three error and status strings are also unbolded, since we reserve bold for buttons, tabs, and other click targets. Inspector walkthrough. The example prompt now matches the screenshot, and the image description names the chart it actually shows. Two things for next time: spell out whole numbers one through nine in prose, and keep the source citation comment at the top of the page pointing at the files you verified against. That comment is how the next person re-checks the page. |
micheleRP
left a comment
There was a problem hiding this comment.
thank you @malinskibeniamin
Description
Updates the agent chart guide to match the current Inspector chart contract.
barandlinecharts, including the top-leveltitlefield.barandlineblocks.User impact
Agent builders get an accurate prompt example and a direct migration path. Existing
barandlineblocks remain documented as compatible; unsupported chart types have explicit conversion guidance.Checks
npm run build)