docs(examples): add managed quickstart and label backends per example - #29
Merged
Conversation
The docs site examples page was missing `managed_memory_quickstart` entirely, so the one example that runs on the default backend was not discoverable from the published docs. It also gave no way to tell which backend each memory example targets, which matters because half of them only work self-hosted. - Add `managed_memory_quickstart` to the memory table. - Add a Backend column to the memory table and a Runner column to all three tables, mirroring what `examples/README.md` already tracks. Several examples run under `adk web .` rather than `python main.py`, which the page did not say. - Note that auto-summarization, extraction strategies, recency-boosted search, and MCP require the self-hosted backend. - Home page said nine runnable agents; there are ten. Also complete the MCP tool table in concepts/memory.md. Agent Memory Server exposes `get_working_memory`, `compact_long_term_memories`, and `get_current_datetime` in addition to the seven already listed (verified against `agent_memory_server/mcp.py`). Verified `mkdocs build --strict` produces the same 64 warnings as unmodified main, none referencing the edited files. All pre-existing griffe docstring warnings in `src/adk_redis/tools/memory/`.
There was a problem hiding this comment.
🟢 Ready to approve
The changes are documentation-only, consistent with existing example metadata, and introduce no behavioral or API surface changes.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Updates the documentation site to make the runnable examples more discoverable and actionable, especially clarifying which Redis Agent Memory backend each memory example targets and how each example should be launched.
Changes:
- Add
managed_memory_quickstartto the docs examples page and label memory examples by backend, plus add runner columns to the examples tables. - Correct the docs landing page count from nine to ten runnable agents.
- Expand the MCP tool list in the memory concept docs to include three additional tools exposed by Agent Memory Server.
File summaries
| File | Description |
|---|---|
| docs/index.md | Updates the landing page summary to reflect the correct total number of runnable agents. |
| docs/examples/index.md | Adds backend and runner metadata to examples tables and includes the managed memory quickstart example. |
| docs/concepts/memory.md | Completes the MCP tool table by listing additional MCP tools. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docs site examples page was missing
managed_memory_quickstartentirely. That is the one example that runs on the default (redis-agent-memory) backend, so the quickest path to a working agent was not discoverable from the published docs at all.The page also gave no way to tell which backend each memory example targets. That matters because half of them only work self-hosted, and
fitness_coach_mcpcannot run on managed at any setting since the managed backend has no MCP endpoint.Changes
docs/examples/index.mdmanaged_memory_quickstartto the memory table.examples/README.mdalready tracks. Several examples run underadk web .rather thanpython main.py, which the page did not say.docs/index.mddocs/concepts/memory.mdget_working_memory,compact_long_term_memories, andget_current_datetimein addition to the seven already listed. Verified againstagent_memory_server/mcp.pyrather than from the changelog.Verification
mkdocs build --strictproduces 64 warnings on this branch and 64 on unmodifiedmain, none referencing the edited files. They are all pre-existing griffe docstring warnings insrc/adk_redis/tools/memory/about parameters documented but absent from the wrapped signatures. Worth a separate cleanup, since they keep--strictfrom ever passing.Scope note
I checked the rest of the published pages against 0.0.9 and they are already current: cache entry IDs and
delete_by_id, client-supplied memory IDs, invocation-user resolution, and all six memory tools are documented. This PR is deliberately small as a result.Two things I left alone on purpose:
docs/for-ais-only/FAILURE_MODES.mdnamescreate_memory_mcp_toolset, but as a prohibition ("do not introduce"), which is correct guidance.docs/specs/examples-memory-coverage-handover.md:164states the helper exists, which is stale, but it is an unpublished historical handover doc rather than user-facing content.Related
Companion redis.io update is redis/docs#3746, which brings those pages from 0.0.5 to 0.0.9.
🤖 Generated with Claude Code