Skip to content

docs(playbooks): document existing-entry UPDATE proposals (MOD-21205) - #4633

Open
tylerhutcherson wants to merge 5 commits into
mainfrom
docs/MOD-21205-playbook-update
Open

tylerhutcherson wants to merge 5 commits into
mainfrom
docs/MOD-21205-playbook-update

Conversation

@tylerhutcherson

@tylerhutcherson tylerhutcherson commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

MOD-21205 · Companion redis-iris PR · redis-iris 1.2.0

Changes

  • Document how to propose a complete replacement for an existing FAQ or skill, review the candidate, and publish the exact version returned by acceptance.
  • Use redis-iris 1.2.0 for the Python and CLI walkthroughs. Python submits with propose_faq or propose_skill and uses playbook.client for the review and publication steps. CLI submissions use --update ENTRY. The displayed Bash scripts stop on errors, and the TypeScript review prints the complete candidate.
  • Use the unified SDK’s public models and errors in all Python examples, and its data-plane and service clients in both live validation scripts. A regression test checks example imports.
  • Align the API reference with the released Playbook 1.3.0 contract. CI runs all four clients using one Python environment.

Validation

  • 125 Playbooks documentation tests passed with the published packages. The FAQ and skill UPDATE cases cover submission through publication for Python, TypeScript, CLI, and cURL.
  • The pinned Hugo build passed. All 16 rendered UPDATE snippets and four full-program copies matched their sources. The guide's sample FAQ JSON and skill packaging command both ran through the unified Python walkthrough.

Note

Low Risk
Changes are documentation, example generation, CI, and test fixtures; no production service code. Risk is mainly keeping SDK/API lock hashes and multi-language examples in sync with released contracts.

Overview
Documents UPDATE proposals—proposing, reviewing, accepting, and publishing a full replacement version for an existing FAQ or skill—alongside the existing ADD flow. The proposals guide, concepts page, and OpenAPI snapshot add update actions, existingEntry targets, and revised operation descriptions; skill upload limits and RFC 9457 links on error schemas are aligned with Playbook 1.3.0.

Unified SDK and examples: Python/CLI walkthroughs pin redis-iris>=1.2.0; live doc validators and local examples switch from redis_agent_playbook to redis_iris.agent_playbooks. New multi-client samples (proposals_update for Python, TypeScript, CLI, cURL) feed doc generation via update_scripts(); TypeScript tabs are limited to the UPDATE set. CI installs Node 22 and @redis-iris/agent-playbook@1.3.0 so pytest can execute the .mts walkthrough.

Tooling and tests: source-lock.json and requirements bump SDK revisions and contract hashes; lock checks focus on the unified package. Fixture servers model UPDATE proposal lifecycle (revision conflicts, deleted targets, skill packages); test_proposal_updates.py runs all four clients end-to-end.

Reviewed by Cursor Bugbot for commit cae2f86. Bugbot is set up for automated code reviews on this repo. Configure here.

@tylerhutcherson

Copy link
Copy Markdown
Contributor Author

@rbs333 Could you review the Playbook UPDATE docs alongside redis/redis-iris#107? Please check the CLI examples and the wording on permissions, version basis, and publication. The example tests passed with the #107 candidate wheel. This draft is staged for the unified CLI release.

@github-actions

github-actions Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 8 related items from repository history:

Memory updated at cae2f86

@dwdougherty dwdougherty added the iris Iris context engine docs label Nov 20, 2026
@tylerhutcherson
tylerhutcherson marked this pull request as ready for review November 20, 2026 20:31

@rbs333 rbs333 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Built locally and generally LGTM only note would be "Use a Playbooks deployment that supports UPDATE proposals" doesn't say which version or how to check which is a bit confusing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

iris Iris context engine docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants