e-volv

Docs playbook

ImplementDocumentationfromIssue

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

Issueissue.labeled
Settle delay
10s after the event

Only when all hold

  • issue.addedLabel equals docs
  • actor.username not contains [bot]
Issueissue.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.

React Flow
  1. 01
    Issue Labeled docstrigger

    The event that starts the run.

  2. 02
    Clone Repositorygit.clone

    Shallow-clones the repository at the right ref.

  3. 03
    Write Documentationagent.run

    One 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 · read
  • create_branchCreate Branch · write
  • create_or_update_fileCreate or Update File · write
  • create_pull_requestCreate Pull Request · write
  • create_issue_commentCreate Issue Comment · write

Filesystem · 4

  • read_fileRead File · read
  • list_dirList Directory · read
  • write_fileWrite File · write
  • edit_fileEdit File · write

Code search · 1

  • code_searchCode Search · read

Status · 1

  • update_statusUpdate Status · write