Skip to content

docs(#3996): document verified generated-image behavior - #4030

Draft
aheritier wants to merge 2 commits into
generated-image-inline-tuifrom
generated-media-docs
Draft

docs(#3996): document verified generated-image behavior#4030
aheritier wants to merge 2 commits into
generated-image-inline-tuifrom
generated-media-docs

Conversation

@aheritier

@aheritier aheritier commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

What

Documents verified generated-image behavior across model configuration, sessions, TUI usage, Google provider guidance, and examples.

Why

Provides a concise, reproducible reference for configuring and using generated images safely.

Validation

Documentation/example review; task test is unchanged by this docs-only PR.

Test instructions

Run:

task test

Follow examples/gemini_image_output.yaml and the generated-image provider, session, and TUI documentation using a supported Gemini image-output model. Expected: the documented configuration is valid and the workflow produces and displays generated media as described.

@aheritier aheritier added area/docs Documentation changes kind/docs Documentation-only changes labels Aug 22, 2026
Some models (e.g. Gemini image-output models) can generate an image as part
of a reply. Docker Agent saves each generated image into the session's
workspace — the directory the session was started in — as an ordinary,
untracked file, not into `session.db` or the data directory. The session

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.

We should keep it in the database, sessions should be portable

@aheritier
aheritier force-pushed the generated-media-docs branch from a5107cd to 962223a Compare August 24, 2026 15:13
@aheritier
aheritier force-pushed the generated-media-docs branch from 962223a to 48a5f96 Compare August 25, 2026 08:01
@aheritier
aheritier force-pushed the generated-media-docs branch from 48a5f96 to 8c8e021 Compare August 25, 2026 08:18
…nd validation walkthrough

User-facing documentation for the generated-media feature across
docs/features/tui/index.md (Generated Media section: storage location,
naming and collision behavior, no-resend placeholders, bounded/sanitized
warning and placeholder wording), docs/features/sessions/index.md
(generated-media lifecycle), and docs/providers/google/index.md
(image-output model guidance), plus a step-by-step manual validation
walkthrough for contributors.
Document that image-output-capable models request TEXT+IMAGE on supported
Google surfaces, with explicit output_capabilities values overriding automatic
models.dev detection. Explain local rejection of unsupported tool and
structured-output combinations, provider-controlled formats and text-only
responses, generated-file naming and collision handling, workspace escape
confirmation, and inline TUI rendering with safe fallbacks.

Update the example and remove stale claims that image output is not requested
or rendered, while keeping developer-only validation details out of user docs.
@aheritier
aheritier force-pushed the generated-media-docs branch from 8c8e021 to 1445548 Compare August 25, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation changes kind/docs Documentation-only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants