docs(ai): add ai-prompts-runbook for operator prompts lifecycle (v1.13.0)#307
Merged
Conversation
…3.0) Documents the three-layer model (bundled / operator / container) and the AI_PROMPTS_DIR / AI_PROMPTS_DIR_HOST contract introduced in v1.13.0. Includes Mermaid diagrams for the layer flow and edit sequence, deploy/ git-pull guarantees, the root:root permissions gotcha verified on the .22 server, and a quick-reference sha256sum command set. No code changes. Does not affect any SDD change apply state. Refs: openspec/changes/ai-chat-markdown-policies/
This was referenced Jun 21, 2026
Re-run CI after the cd.yml shellcheck fix landed on main to confirm actionlint and lint-verify (PR1 gate) turn green for this branch.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds
docs/ai-prompts-runbook.mddocumenting the three-layer model for AI prompt files introduced in v1.13.0:backend/ai/(tracked code, read-only seed source).docker/ai/or.ai/(gitignored, editable data)/data/ai/insidenexgen_backend(live bind-mount)Why
The pattern is documented in code (
backend/ai/README.md) but the twoAI_PROMPTS_DIRvsAI_PROMPTS_DIR_HOSTvariables, the deploy/git-pullguarantees, and the
root:rootpermissions gotcha were easy to get wrong.This runbook makes the operator workflow auditable in one place.
What's in the runbook
AI_PROMPTS_DIRvsAI_PROMPTS_DIR_HOSTtable (with the common mistake).env.22server + two fix optionssafe-rebuild.sh)sha256sumone-linersOut of scope
Refs: openspec/changes/ai-chat-markdown-policies/