Skip to content

docs(examples): add managed quickstart and label backends per example - #29

Merged
nkanu17 merged 1 commit into
mainfrom
docs/examples-index-0.0.9-parity
Aug 3, 2026
Merged

docs(examples): add managed quickstart and label backends per example#29
nkanu17 merged 1 commit into
mainfrom
docs/examples-index-0.0.9-parity

Conversation

@nkanu17

@nkanu17 nkanu17 commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

Why

The docs site examples page was missing managed_memory_quickstart entirely. 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_mcp cannot run on managed at any setting since the managed backend has no MCP endpoint.

Changes

docs/examples/index.md

  • 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.

docs/index.md

  • Said "Nine runnable agents"; there are ten.

docs/concepts/memory.md

  • Complete the MCP tool table. 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 rather than from the changelog.

Verification

mkdocs build --strict produces 64 warnings on this branch and 64 on unmodified main, none referencing the edited files. They are all pre-existing griffe docstring warnings in src/adk_redis/tools/memory/ about parameters documented but absent from the wrapped signatures. Worth a separate cleanup, since they keep --strict from 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.md names create_memory_mcp_toolset, but as a prohibition ("do not introduce"), which is correct guidance.
  • docs/specs/examples-memory-coverage-handover.md:164 states 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

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/`.
Copilot AI review requested due to automatic review settings August 3, 2026 15:21

Copilot AI 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.

🟢 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_quickstart to 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.

@nkanu17
nkanu17 merged commit 57c9769 into main Aug 3, 2026
4 checks passed
@nkanu17
nkanu17 deleted the docs/examples-index-0.0.9-parity branch August 3, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants