Documentation backlog

[TonsOfFun]

One place for the open documentation requests, so the individual issues (some from mid-2025) can be closed as duplicates of this list. Check items off as pages land; every code example in the docs should come from a tested file under test/ per contributing/documentation.

Guides and sections

• Generative UI section (Docs: Add section for Generative UI #68). How agents render HTML/Turbo responses from action views.
• Multi-agent workflows and interactions (Examples: Multi-agent workflows and interactions #87). Examples of agents calling agents, supervisors, and hand-offs.
• More output and usage examples (Provide more output and usage examples in the docs #132). Response shapes, response.message, structured output, embeddings.
• Tool usage and caching (Improve docs for tool usage and caching #174). Tool-call round trips, tools_function, and provider caching options.
• Model supported actions (Document and test model supported actions #195). Document and test which providers/models support tools, structured output, streaming, and multimodal input.
• MCP as tools: tests, docs, examples (Add tests, docs, and examples for MCP as tools #208). Both the Anthropic and OpenAI mcps: shapes, allowed_tools / require_approval, and the engine's /mcp facade.
• OpenTelemetry examples (Add examples for open telemetry #212). Wiring activeagents-telemetry to an OTel collector and to the dashboard.
• Rails cache store usage (Document Rails Cache Store usage #234). What ActiveAgent caches and how to configure config.active_agent.cache_store.
• Fast MCP examples (Document Fast MCP examples #157). A FastMCP server consumed by an agent.

Fix-ups to existing pages

• Update the Travel Agent example (Docs: Update Travel Agent example #69) to the 1.x API.
• Link the remaining snippets (Link these snippets too #74) so every example references a test/ region.
• Doc search breadcrumbs from front-matter titles (Doc search has an issue with breadcrumbs from front matter title #269). VitePress search shows the wrong breadcrumb when the front-matter title differs from the H1.
• User documentation and guides for the dashboard engine (Create user documentation and guides #257). Getting started with actionagent, mounting, authentication seams, and telemetry ingest.