Auto Docs Update on Merge
Start with a built-in AI playbook, customize it as needed, or build your own
Look for changes after a pull request is merged and update the documentation accordingly.
Loading workflow...
git.clone
git.clone
agent.run
You are acting as a Documentation Planner.
Do NOT write docs yet.
agent.session
You are given a pre-defined plan with a list of documentation task based on the recent merged PR. Your goal is to create a new PR on the docs repository, following this process:
Input list format:
Instruction to Tech Writer (per item):
``` { "target": "docs/path/to/file.md" | "new file", "action": "update" | "create" | "skip", "reason": "why this target/action", "files_written": ["docs/path/to/file.md", "docs/images/new.png"], "notes": "any warnings (links, anchors, frontmatter)" } ```
Rules:
create
only when no suitable target exists.skip
, explain why.Do not commit during Step 1.
Preconditions: At least one item with action
∈ {update
, create
}.
Instruction to Tech Writer:
docs/autogen/{sourceRepo}/{prNumber}-{shortSha}
.docs: updates for {sourceRepo}#{PR_NUMBER} ({shortSha})
Docs: update for {sourceRepo}#{PR_NUMBER} – {short summary}
If there are no actionable items, exit cleanly without creating a branch or PR.
Docs plan: {{outputs.plan-docs.message}}
Try Auto Docs Update on Merge now