Skip to content

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

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

docs(#3996): document verified generated-image behavior#4030
aheritier wants to merge 3 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
Comment thread docs/features/sessions/index.md Outdated
aheritier

This comment was marked as resolved.

@aheritier
aheritier force-pushed the generated-media-docs branch 2 times, most recently from 7bf4821 to 6edff56 Compare September 6, 2026 16:16
@aheritier
aheritier force-pushed the generated-media-docs branch from 6edff56 to 2a33362 Compare September 7, 2026 11:19
@aheritier
aheritier force-pushed the generated-media-docs branch 2 times, most recently from 20caea4 to e54ff19 Compare September 7, 2026 16:13
Add the initial TUI and session lifecycle documentation, owner-qualified
references, no-resend placeholders, sanitization and a manual walkthrough.
This patch describes the historical data-directory session_artifacts
layout, not the workspace/portable-blob implementation, and edits only
docs/features/tui/index.md and docs/features/sessions/index.md. The complete
generated-media documentation replaces that storage description.
Document TEXT+IMAGE on supported Google surfaces, explicit output-capability
overrides over models.dev, ordinary-request guards, provider-controlled
formats and text-only replies. Explain naming/collisions, workspace escape
confirmation and inline rendering with fallback labels.

Correct the title-model reference to retain image-output models for utility
calls, update the Google example, and replace stale claims that image
output is neither requested nor rendered. The completed portable-storage
documentation supplies the warning and storage caveats.
Describe workspace deliverables plus complete portable session blobs,
manifest-gated blob-first restoration and uncapped legacy file fallback.
User-attachment limits are unchanged. Explain in-place schema compatibility
and disposable compatibility testing without active-database management
instructions; consistent snapshots include stored portable copies.

Document ordinary follow-up placeholders separately from explicit file
attachment or tool reads. State the accepted phrase-based missing-image
warning limits and the exactly-one-returned-image prompt filename fallback.
For external-path denial, describe redirection rather than guaranteed save
success: a redirected write can still emit a per-item failure warning.
@aheritier
aheritier force-pushed the generated-media-docs branch from 468f9cd to 48cef72 Compare September 8, 2026 17:31
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