Skip to content

docs: update /docs for PRs merged 2026-06-18–20#3183

Merged
dgageot merged 6 commits into
mainfrom
docs/auto-update
Jun 20, 2026
Merged

docs: update /docs for PRs merged 2026-06-18–20#3183
dgageot merged 6 commits into
mainfrom
docs/auto-update

Conversation

@aheritier

Copy link
Copy Markdown
Contributor

Updates documentation to reflect code changes from the last 36 hours (2026-06-18 12:00 UTC to 2026-06-20).

Changes per source PR:

PRs not requiring doc changes: #3179 (changelog-only), #3175 (already added YAML anchors docs), #3177 (internal refactor), #3173 (internal bug fix), #3172 (internal refactor), #3170 (dependency bumps), #3169 (internal bug fix), #3166 (already added MCP timeout docs), #3163 (already added shell sudo_askpass docs), #3162 (internal bug fix).

…g cycle

PR #3178 fixed the Shift+Tab thinking level cycle to offer the 'max'
effort tier on Claude models that support it.

Changes:
- docs/guides/thinking/index.md: Replace the flat effort-level table
  with a per-model capability matrix. Correct the Shift+Tab cycle
  description to include 'max' for Opus 4.7+, Fable 5, Mythos 5; and
  document that Sonnet 4.6 and Opus 4.6 cycle to 'max' but not 'xhigh'.
  Update the adaptive-thinking heading and callout to mention Sonnet 4.6.
- docs/providers/anthropic/index.md: Change 'Claude Opus 4.6+ only' to
  'Claude Opus 4.6+, Sonnet 4.6' in the adaptive/effort-based section;
  update the coercion note to include Sonnet 4.6.

Source: #3178
…in, optional providers

- PR #3171 (pkg/embeddedchat): Add 'Headless Embedded Chat' section to
  docs/guides/go-sdk/index.md documenting the Config, Session, Event
  types and the Send/Confirm/Restart/Close API with worked examples.
- PR #3174 (RAG opt-in): Add 'RAG Toolset (cgo-free builds)' section
  explaining that pkg/rag must be blank-imported to register the toolset,
  allowing embedders to omit it and avoid the cgo dependency.
- PR #3176 (optional providers): Add 'Optional Provider Build Tags'
  section listing docker_agent_no_{openai,anthropic,google,bedrock} tags
  with the major dependency each removes and the Anthropic+Google note.
- Add pkg/embeddedchat row to the Core Packages table.

Sources:
  #3171
  #3174
  #3176
Adds an Unreleased section to CHANGELOG.md for PR #3181, which landed
after the v1.83.0 cut and adds settings.lean to the user config file.

The TUI feature page already documents the setting; this commit records
the change in the changelog.

Source: #3181
- go-sdk: fix embeddedchat example to use dagentcfg.NewBytesSource
  (was erroneously named BytesSource with wrong arity); add missing
  dagentruntime import; check error return from chat.Confirm
- thinking: split 'Fable 5 / Mythos 5' column into separate 'Mythos 5'
  and 'Mythos preview' columns; Mythos preview only supports max (not
  xhigh), matching pkg/modelinfo/thinking_levels.go
@aheritier aheritier requested a review from a team as a code owner June 20, 2026 04:21
@aheritier aheritier added the kind/docs Documentation-only changes label Jun 20, 2026

@docker-agent docker-agent left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Assessment: 🔴 CRITICAL

2 high-severity issues found in the new pkg/embeddedchat documentation:

  1. Wrong approval scope in code example (ResumeApproveSession() vs ResumeApprove())
  2. Wrong blank-import path for RAG toolset registration (pkg/rag does not register the toolset)

Comment thread docs/guides/go-sdk/index.md Outdated
response.WriteString(ev.Text)
case ev.Tool != nil && ev.Tool.NeedsConfirmation:
// Approve or reject the pending tool call.
if err := chat.Confirm(ctx, dagentruntime.ResumeApproveSession()); err != nil {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[HIGH] Wrong approval scope — ResumeApproveSession() should be ResumeApprove()

The comment says "Approve or reject the pending tool call" (a single call), but dagentruntime.ResumeApproveSession() approves all tool calls for the entire session — a blanket grant that bypasses every future confirmation prompt. This is a much broader permission than the example intends.

For approving only the currently pending tool call, use ResumeApprove():

if err := chat.Confirm(ctx, dagentruntime.ResumeApprove()); err != nil {
    return err
}

Use ResumeApproveSession() only when you explicitly want to suppress all remaining confirmations for the session (e.g. after the user clicks "allow all"). Using it here teaches developers an overly permissive pattern by default.

Comment thread docs/guides/go-sdk/index.md Outdated

```go
import (
_ "github.com/docker/docker-agent/pkg/rag" // register RAG toolset

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[HIGH] Wrong blank-import path for RAG toolset registration

The documented import _ "github.com/docker/docker-agent/pkg/rag" will not register the RAG toolset. The pkg/rag package is the cgo tree-sitter implementation library — it has no init() that calls teamloader.RegisterToolsetCreator.

The registration init() function lives in pkg/tools/builtin/rag/register.go. Blank-importing that package is what wires the "rag" toolset type into the teamloader registry:

import (
    _ "github.com/docker/docker-agent/pkg/tools/builtin/rag" // register RAG toolset
)

With the current import, a config declaring type: rag will still fail with "toolset type not registered" at startup — exactly the error the documentation promises this import will prevent.

…t path

- Replace ResumeApproveSession() with ResumeApprove() in the embeddedchat
  confirmation example; the former blanket-approves all future tool calls
  for the session, the latter approves only the currently pending call.
- Fix RAG blank-import path: pkg/rag is the cgo library and has no init()
  that registers the toolset; the registration init() lives in
  pkg/tools/builtin/rag/register.go, so the correct import is
  _ "github.com/docker/docker-agent/pkg/tools/builtin/rag".
@aheritier

Copy link
Copy Markdown
Contributor Author

Addressed both HIGH-severity findings in commit 847f960:

Comment 1 (line 93 — wrong approval scope): Changed ResumeApproveSession()ResumeApprove() in the embeddedchat confirmation example. ResumeApprove() approves only the currently pending call; the comment now notes that ResumeApproveSession() is appropriate when the user explicitly wants to allow all remaining confirmations for the session.

Comment 2 (line 165 — wrong RAG import path): Corrected the blank-import path from pkg/rag (the cgo library, no registration init) to pkg/tools/builtin/rag (contains register.go with the init() that calls teamloader.RegisterToolsetCreator("rag", ...)).

@aheritier aheritier added the area/docs Documentation changes label Jun 20, 2026
@Sayt-0 Sayt-0 assigned Sayt-0 and unassigned Sayt-0 Jun 20, 2026
@dgageot dgageot merged commit 3e15f0d into main Jun 20, 2026
9 checks passed
@dgageot dgageot deleted the docs/auto-update branch June 20, 2026 10:00
Sayt-0

This comment was marked as resolved.

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.

4 participants