How Doc Holiday Works
The user-seat loop: request → plan → draft from source → review → pull request.
Doc Holiday turns a request into a plan, a draft, a review, and then a pull request.
This is the loop at a glance.
Stage 1: request
A request can start in four places, and all four produce the same kind of work item:
In git, mention Doc Holiday in a pull request comment. See Request work in git.
In the app, enter a plain language request. See Request work in the app.
From a configured trigger, a release or merge event starts the work automatically. See Configure triggers.
From CI, the GitHub Action can send the request for you. See GitHub Action.
Stage 2: plan
Doc Holiday reads the request together with what it already knows about the Publication and its connected Sources. It turns that into file-level work items that name where the writing will land. The request and its progress appear in Work History.
Stage 3: draft
Doc Holiday reads the real source, compares it with the docs it maintains, and drafts proposed diffs. The drafts wait for your review on a working branch; nothing reaches your default branch except through a pull request you approve.
Stage 4: review
You review the draft, leave comments, and ask for changes when something needs another pass. Doc Holiday revises the same work and keeps the draft visible until it is ready. See Review and revise.
Stage 5: pull request
When you approve the draft, Doc Holiday opens a normal pull request in the docs repo. Your docs repo stays yours: approved content lands there only through that pull request, and the merged result lives in your repository like any other change.
Last updated
Was this helpful?