Skip to content

docs: document alias list --json flag and failure-safe conversation caching#2977

Merged
dgageot merged 2 commits into
mainfrom
docs/auto-update
Jun 3, 2026
Merged

docs: document alias list --json flag and failure-safe conversation caching#2977
dgageot merged 2 commits into
mainfrom
docs/auto-update

Conversation

@aheritier
Copy link
Copy Markdown
Contributor

Summary

This PR updates the documentation to reflect two features merged into main in the last 36 hours.

Changes

  • docs/features/cli/index.md — Document the --json flag added to docker agent alias list in #2966. Added a --json usage example in the alias usage block, a full JSON output example showing the name/path/options fields, and a note that output is sorted by name and omits false/zero-valued fields.

  • docs/features/chat-server/index.md — Document the failure-safe conversation caching behavior fixed in #2947. Added a new "Failure-safe caching" subsection explaining that failed requests (model error, timeout) leave the cached conversation unchanged, clients can safely retry with the same X-Conversation-Id, and transient errors do not corrupt conversation history.

Source PRs covered

Commit Source PR What changed
d2de0e1 #2966 alias list --json machine-readable output flag
73f37cf #2947 Failure-safe conversation cache (failed turns do not corrupt cache)

@aheritier aheritier requested a review from a team as a code owner June 3, 2026 04:06
@aheritier aheritier added the kind/docs Documentation-only changes label Jun 3, 2026
Copy link
Copy Markdown

@docker-agent docker-agent left a comment

Choose a reason for hiding this comment

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

Assessment: 🟢 APPROVE

The documentation additions are accurate and consistent with the PR description. Both the --json flag documentation for docker agent alias list and the failure-safe conversation caching subsection are clear, technically sound, and match the behavior described in the referenced source PRs (#2966 and #2947). No issues found.

@dgageot dgageot merged commit 8652382 into main Jun 3, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/docs Documentation-only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants