Repository navigation
WIP: Redis Agent Playbooks developer docs - #4249
tylerhutcherson wants to merge 12 commits into
Conversation
|
|
🧠 Redis MemoryFound 9 related items from repository history:
Memory updated at 76f9293 |
tylerhutcherson
added
documentation
|
This needs the same re-base as the other PR in this stack to get the new nav and look/feel. I've also added Andy and Paolo for their review of the build changes proposed here and anything else they see. In case we can pull off some interactive demo of this component and also to get more eyes on this in the final sprint. |
andy-stark-redis
left a comment
andy-stark-redis
left a comment
There was a problem hiding this comment.
@tylerhutcherson The language mainly looks OK but I've made a few comments here and there. However, the PR seems to invent a whole new system for supplying the code examples when we already have a really good one available :-)
I've added a new commit to enable three new language variants in the docs for Iris Python, TS, and cURL examples (they are listed as if they were "clients" because that is what we mainly deal with in the docs). We have a Claude skill for adding tabbed code examples (TCEs), so if you ask for the examples to be reworked in this form, it should know what you mean. The example source files should be placed in local_examples/iris.
The TCE boxes on the published page allow you to copy the full text of the example rather than download, so any surrounding body text that refers to downloading example files will need to be removed. Some of the build scripts you've added will also be unnecessary when the examples are redone as TCEs.
If you encounter any problems with this then just let me know and I'll be happy to help out.
| bannerChildren: true | ||
| --- | ||
|
|
||
| Redis Agent Playbooks lets agents share curated answers and procedures without bundling them into each application. Publish a version, retrieve it for a task, and prepare revisions while agents use the current publication. |
There was a problem hiding this comment.
We need to decide if we regard "Playbooks" (plural) as the product/feature name or whether we can sometimes consider an individual "Playbook" as being part of a collection. If it's a feature with a plural name, it might be clearer to say things like "Redis Agent Playbooks is a feature that lets agents share...". If they are regarded as individual items, we can say "Redis Agent Playbooks let agents...".
It's a little pedantic, I know, but "Playbooks lets agents share..." takes a moment to parse or possibly seems like a typo.
There was a problem hiding this comment.
Agreed - still trying to decide on this from a product standpoint.
| @@ -0,0 +1,513 @@ | |||
| --- | |||
There was a problem hiding this comment.
Calling them FAQs is a nice, intuitive way to describe them, but I wonder if the URL here is prone to hallucinations? (We get lots of these, btw.) Maybe use manage-faqs or playbook-faqs for the filename?
|
|
||
| {{< /multitabs >}} | ||
|
|
||
| To roll back, publish the first version retained in `version` (Python and TypeScript) or `VERSION` (HTTP). |
There was a problem hiding this comment.
The issue with variants of names is handled inconsistently - sometimes differences are ignored (eg, list_faqs) and sometimes called out (eg, here and next_cursor, etc). It's probably best to just use the Python variant of the names in the main text and let the reader/LLM make the leap. If we find readers are tripped up by this, we can add a note at the top explaining how to convert among the naming conventions.
Updating to use the existing TCE structure and format! |
…amples Adds three TCE pseudo-client keys, "Python (Iris)", "TypeScript (Iris)", and "cURL (Iris)", so Iris examples can use the standard clients-example system instead of multitabs. Each key is the visible tab title and is shared across all Iris products, so names avoid any one SDK package. - config.toml: keys in clientsExamples and clientsConfig, modeled on RedisVL. Own clientId (iris-python/-typescript/-curl), empty quickstartSlug and mappingClientId, so tabs don't carry redis-py or node-redis identity in the code-examples JSON metadata. - build/local_examples.py: .ts/.mts -> typescript, .sh -> bash; a path containing 'iris' selects the Iris client (put sources under local_examples/iris/). .mts keeps top-level await working under tsx. Non-Iris .ts/.sh files resolve to no configured client. - build/components/example.py: comment prefixes for typescript (//) and bash (#); without them Example() rejects the language. Verified with a throwaway three-language set: the build tagged each file with the right client and Hugo rendered the tabs with correct step slices, lexers, full-file templates, and clientId/clientName. The test set was removed; no pages are converted in this commit. Gotcha: get_example_id_from_file reads only line 1, so .sh sources must start with "# EXAMPLE:" and cannot carry a shebang. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Discover turn context through the SDK before running OpenAI Agents SDK or LangGraph. Keep standard MCP clients and tool guidance on the existing MCP page, and suppress drafts while tool failures remain unresolved.
c0ef4a2 to
d7293c3
Compare
tylerhutcherson
changed the title
4 participants
MOD-19391 — Redis Agent Playbooks developer documentation.
Adds the developer docs under
/develop/ai/context-engine/agent-playbook/. Developers can publish and retrieve approved answers, package reusable procedures, review proposals and evidence, and supply playbook knowledge to an agent before and during a turn.Scope
/manage-faqs/and/manage-skills/routes, consistent navigation, and updated cross-links. The landing page follows the Redis Agent Memory structure with “What is…” and “Why use…” sections, then links directly to Concepts, Quickstart, and Agent integration.local_examples/iris/playbooks/, standardEXAMPLE/STEPmarkers and local-examples processing, andclients-exampletabs with complete-program copying. No separate downloadable-example or site-rendering pipeline. The scoped test adapter reads those same sources through the standard processor.Rebased onto current
mainand its Iris navigation. Operator setup and its cross-links belong to the separate stacked PR; Cloud provisioning, extraction setup, service changes, and launch package upgrades are outside this PR.Latest updates
252d8df9e— Adds the landing-page navigation cards and improves the readability of the Python examples without changing behavior.a73af6b9a— Adds and places the four Agent Playbooks workflow diagrams with accessible alt text and consistent sizing.76f929323— EstablishesRedis Agent Playbooksas the product name and lowercaseplaybookorplaybooksfor instances, with matching landing-page benefits and example wording.Validation
python -m pytest build/agent_playbook_docs --rootdir . -q: 126 passed in an isolated environment using the pinned dependencies. Checks cover the locked public SDK/OpenAPI contract, displayed sequences and full copies, request parity, cleanup, framework ordering/context delivery, FAQ-only answers, stale recovery with changed identifiers/versions, and unresolved-tool-error handling.git diff --checkpass.The repository does not define the generic
task lintortask testcommands, so validation uses its dedicated Playbooks suite and documented Hugo build instead.Review readiness and remaining work
The core developer documentation is ready for human review now. These remaining items require product or launch alignment and belong in follow-up work:
ClearPlaybook, while the newer service clears through the control plane and returns 404 on the old route.Stack and publication
MOD-19391-playbook-developer-docs→main.mainand confirm its remaining diff.Both PRs stay draft/WIP. No publication gate is added. Merging into
mainpublishes the docs; draft state does not hide merged pages. Keep both unmerged until launch publication is approved. Repository and staging previews are public.