Docs playbook
Implement Documentation from Issue
Turns docs-labeled issues into documentation PRs written in the repository’s existing style.
When an issue is labeled 'docs' or 'documentation', research the relevant code, write the requested documentation in the repository's existing style, and open a PR linked back to the issue.
- Identifier
implement-documentation-from-issue- Version
- 1.0.1
- Steps
- 3
- Triggers
- 2
- docs
- issues
- pull-request
- automated
When it runs
Issue
issue.labeled- Settle delay
- 10s after the event
Only when all hold
- issue.addedLabel equals docs
- actor.username not contains [bot]
Issue
issue.labeled- Settle delay
- 10s after the event
Only when all hold
- issue.addedLabel equals documentation
- actor.username not contains [bot]
The pipeline
The graph below is the one the workflow opens with in the builder, same steps, same layout, drawn on the same canvas. The run playing through it is a simulation; the branches and conditions are real.
- 01Issue Labeled docs
triggerThe event that starts the run.
- 02Clone Repository
git.cloneShallow-clones the repository at the right ref.
- 03Write Documentation
agent.runOne agent works the task with its toolkit.
The agent
Documentation Writer
- Base type
- Tech Writer
- Temperature
- 0.3
- Max iterations
- 40
- Tools
- 11
Git provider · 5
list_pull_requestsList Pull Requests · readcreate_branchCreate Branch · writecreate_or_update_fileCreate or Update File · writecreate_pull_requestCreate Pull Request · writecreate_issue_commentCreate Issue Comment · write
Filesystem · 4
read_fileRead File · readlist_dirList Directory · readwrite_fileWrite File · writeedit_fileEdit File · write
Code search · 1
code_searchCode Search · read
Status · 1
update_statusUpdate Status · write
Related playbooks
Auto Update AGENTS.mdNightly scan that keeps the AGENTS.md AI-context file current, opening a PR only when it drifts.Release PR DescriptionWrites user-facing, categorized release notes into the body of every release/* pull request.Auto Docs Update on MergeWatches merged PRs and opens follow-up PRs when code changes affect existing docs.