Skip to content

Align Playbooks developer and operator docs for GA - #4429

Merged
tylerhutcherson merged 2 commits into
iris-ga-docsfrom
docs/playbooks-ga-alignment
Nov 3, 2026
Merged

tylerhutcherson merged 2 commits into
iris-ga-docsfrom
docs/playbooks-ga-alignment

Conversation

@tylerhutcherson

@tylerhutcherson tylerhutcherson commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

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.

Latest commit: 966bb2530.

Launch checks

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

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.

@tylerhutcherson tylerhutcherson added documentation Improvements or additions to documentation iris Iris context engine docs labels Nov 2, 2026
@CLAassistant

CLAassistant commented Nov 2, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 7 related items from repository history (2 new this commit):

Memory updated at 966bb25

@tylerhutcherson
tylerhutcherson marked this pull request as ready for review November 2, 2026 21:59

@cursor cursor Bot 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.

Stale Bugbot comment from a previous run.

@cursor cursor Bot 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.

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 966bb25. Configure here.

@tylerhutcherson
tylerhutcherson merged commit 28a487c into iris-ga-docs Nov 3, 2026
103 of 104 checks passed
@tylerhutcherson
tylerhutcherson deleted the docs/playbooks-ga-alignment branch November 3, 2026 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation iris Iris context engine docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants