You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Align Playbooks developer and operator docs for GA - #4429
Readers need one reproducible path from Playbook provisioning to published guidance. This change aligns the developer and operator docs with the reviewed API, standardizes setup across Python, CLI, and cURL, and completes the proposal and extraction handoffs.
Developer docs
Use the GA umbrella installation command and three canonical IRIS_AGENT_PLAYBOOKS_* variables in .env, with environment-based Python clients and direct CLI/cURL use.
Present Python, CLI, and cURL in that order where supported. Remove 14 TypeScript examples and their npm/compiler/CI dependencies.
Cover skill ZIP proposals, revision-bound resource reads, digest verification, acceptance/publication, and observed inventory counts.
Align HTTP/CLI, Python, and MCP parameter tables with the SDK contract and backend source. Clarify discovery defaults, evidence fields, flat CLI authoring files, and required versus optional revision checks.
Apply Michelle Luna’s subject–verb agreement corrections across the indexes and related Playbooks references.
Operator docs and validation tooling
Clarify runtime versus authoring permissions, key replacement/revocation, extraction prerequisites, pause behavior, and missing-output diagnosis.
Add service recovery guidance and align shared setup with Configuration/Connect.
Preserve original operator-validation failures when resource cleanup also fails, with regression cases for deletion and client-close failures.
Validation
111 scoped checks pass locally and in clean Python 3.12 CI, including dotenv copy-and-run, request serialization, proposal-resource integrity, agent/MCP failure handling, and cleanup diagnostics.
SDK source/contract parity, actionlint, and whitespace checks pass. The API audit changes only operation descriptions; request/response schemas and routes are preserved.
Final local end-to-end validation runs all 28 Python/CLI/cURL programs copied through the preview’s actual copy buttons, including two real-model agent integrations. All pass. Copied skill-package preparation also passes. Earlier validation covers nine operator scenarios including real Agent Memory extraction into an unpublished FAQ.
Browser checks cover 17 pages at 1440 px and 390 px, tab order, agreement fixes, and snippet/full-program copy parity for 60 example groups / 163 client bindings per width. All 146 audited internal links/anchors and eight images resolve; the downloaded contract contains 40 operations.
Full 20,406-page Hugo build passes with existing warnings outside Playbooks. Disposable live resources and temporary credentials were cleaned up.
Validation details are recorded in for-ais-only/agent-playbooks-docs-review.md. The operator tests’ Memory SDK dependency is transitively pinned: redis-iris==1.0.0b2 requires redis-agent-memory==1.0.0b1, confirmed by package metadata and the clean CI installation log.
Publish the stable redis-iris package before GA: the documented >=1.0.0 installation currently cannot resolve. Deterministic validation uses the available 1.0.0b2 packages.
Deploy a backend compatible with the reviewed contract. The older local data plane rejects skill proposals; the SDK-matched backend passes them.
Complete an authenticated Cloud console walkthrough. Console labels were checked against source; console environment-block/skill-prompt changes remain UI work.
A shared Hugo incremental-render issue can omit full-copy templates after editing; fresh builds pass. The local preview was restarted after final edits.
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
documentationImprovements or additions to documentationirisIris context engine docs
4 participants
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.
Readers need one reproducible path from Playbook provisioning to published guidance. This change aligns the developer and operator docs with the reviewed API, standardizes setup across Python, CLI, and cURL, and completes the proposal and extraction handoffs.
Developer docs
IRIS_AGENT_PLAYBOOKS_*variables in.env, with environment-based Python clients and direct CLI/cURL use.Operator docs and validation tooling
Validation
Validation details are recorded in
for-ais-only/agent-playbooks-docs-review.md. The operator tests’ Memory SDK dependency is transitively pinned:redis-iris==1.0.0b2requiresredis-agent-memory==1.0.0b1, confirmed by package metadata and the clean CI installation log.Latest commit:
966bb2530.Launch checks
redis-irispackage before GA: the documented>=1.0.0installation currently cannot resolve. Deterministic validation uses the available1.0.0b2packages.Base:
iris-ga-docs, the integration branch for Redis Iris GA docs #4400.Related: Iris GA Bug Bash MOD-20222, developer publication MOD-19391, and operator publication MOD-19679.