Repository navigation
Figure surfaces (Mermaid/SVG/Markdown) in the skill and examples; bundled grill-with-docs - #4
Merged
Conversation
schemaui ≥ 0.16 renders figures, and the skill now teaches the agent when to reach for them: x-content puts a Mermaid diagram, an inline SVG or sanitised Markdown above a question; x-options attaches a figure to each enum option (aligned by index, radio/select only — segmented has no room for one); x-control: "mermaid" makes the answer itself a diagram edited with a live preview. The cheat sheet gains the four rows, the version note distinguishes the 0.14 control hints from the 0.16 figure surfaces, and the hard rules (non-empty source, aligned lengths, no figures on "none" options, figure explains but is never the value) are stated where the agent will actually read them. Open-ended designs need an interview before they become a schema, so a grill-with-docs skill ships bundled: one question at a time, every question carrying a recommended answer, every question grounded in the project docs and the galleries. The main skill defers to whatever grilling skill the user already has and only falls back to the bundled one when none exists — a convenience for fresh installs, never an override.
deployment-architecture.schema.json is the figure-surfaces reference: three topologies, three rollout strategies and two data layers each carry their own Mermaid diagram (radio and select both shown), the network section explains itself with a node-level x-content figure, an escape-hatch select stays figure-free on purpose, and a mermaid control lets the user edit the call graph as the answer. web-research-brief gains the two non-editor surfaces: a process figure above the depth slider (x-content) and an editable report-flow diagram (mermaid control). READMEs embed three screenshots — the control gallery, figure-bearing options, and the live mermaid editor — and document the new surfaces, the bundled grill skill, and the new example.
The e2e helpers probed /api/session and /api/exit — routes that existed before the engine versioned its API at /api/v1/*, and cargo-binstall installs the latest release, so every round-trip test 404'd the moment a CI job picked up a modern engine. Both the shared drive_session helper and the two inline session reads now try /api/v1 first and fall back to the unversioned routes, so old and new engines both pass. The web-research-brief showcase contract also covers the two new surfaces from this branch: the mermaid x-content above the depth slider, and /report_flow's mermaid control in the hinted-controls map.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the skill up to date with schemaui 0.16's figure rendering, so agents write forms that show instead of tell — and ships an interview skill so fresh installs can grill without installing anything else.
1. Figure surfaces in SKILL.md
x-content— a Mermaid diagram, inline SVG, or sanitised Markdown block rendered above a question, for context a sentence can't carry.x-options— each enum option (aligned by index) can carrylabel,descriptionand a figure; the user picks a topology by recognising the picture.radio/selectshow them;segmentedhas no room and is rejected.x-control: "mermaid"— the answer itself is a diagram, edited in a source editor with a live preview.source, index-aligned lengths, no figures on "none" options, a figure explains but is never the value) are stated up front.2. Bundled
skills/grill-with-docsOpen-ended designs need an interview before they become a schema. The bundled skill keeps the grill-me discipline — one question at a time, every question with a recommended answer, explore instead of asking, stop when converged — and adds grounding: read the cheat sheet, the examples and the engine's galleries before drafting. The main SKILL.md defers to whatever grilling skill the user already has and only falls back to the bundled one when none exists.
3. Examples and screenshots
examples/deployment-architecture.schema.json(中文): three topologies, three rollout strategies and two data layers, each option with its own diagram; a node-levelx-contentfigure on the network section; a figure-free escape hatch on purpose; amermaidcontrol whose answer is the call graph itself.web-research-briefgains the two non-editor surfaces: a process figure above the depth slider and an editable report-flow diagram.Test plan
examples/loads clean throughschemaui web-snapshot(engine ≥ 0.16)pytest tests/: 21 passed; the 6 pre-existing e2e failures reproduce onmainwithout these changes (environment, not this PR)