A manual is your product's set of numbered chapters, and a chapter is one page of that manual whose factual sentences are anchored to your code. You write the brief; DeployLog writes the prose and records, for every sentence that states a value, exactly where that value lives in your repository. Each recorded link is a claim: one sentence in the chapter, one exact value in one exact file.
The loop:
- Create a chapter. It gets a number and a title.
- Generate. A generation is one run that turns your brief and a list of source files into the chapter's prose and its claims.
- Read the claims before you read the prose.
- Cold read the chapter front to back, the way a stranger to the code would.
- Approve. Approval opens a pull request against your repository.
- Merge, then publish the chapter from its page.
- Cut a version when the set is ready. A version pins each cited repository to a commit.
The public manual lives at /p/<slug>/manual and lists published chapters only, in your order. Until one chapter is published, that address is not found.
The free allowance is five manual generations a month.
On a pull request, the GitHub Action in mode: verify annotates drift on the changed lines, and fail-on decides which findings fail the check. From your terminal, deploylog manual verify runs the same check and answers with its exit code.
Your repository stays canonical. Nothing lands in git until the pull request an approval opens is merged.