// End-to-end workflow for PR documentation — check, write, review. Use at any stage of documenting PR changes.
Resolve vendor/ conflicts during a merge, rebase, or dependency upgrade on main or release branches
Assess documentation status for each PR in a Tempo release — classify gaps and identify existing docs that need updating
Write or update Tempo docs for user-facing PR changes identified by docs-pr-check
Review documentation changes for style, accuracy, and completeness. Use when docs have been written or updated and need a quality check before submission.
Update Go version across the Tempo codebase (go.mod, tools/go.mod, Dockerfile, CI workflows, tools image tag)
| name | docs-workflow |
| description | End-to-end workflow for PR documentation — check, write, review. Use at any stage of documenting PR changes. |
| allowed-tools | Bash Read Grep Write |
A three-step pipeline for documenting PR changes. Each step uses an existing skill; this workflow ties them together.
You can use this workflow at any stage — before creating a docs PR, while drafting, or after PRs have shipped. It works the same way regardless of timing.
Invoke with /docs-workflow.
Provide:
main, release-2.10)Read .agents/doc-agents/shared/docs-context-guide.md for repo orientation: code-to-docs mapping, key file paths, and Tempo conventions.
Run .claude/skills/docs-pr-check/SKILL.md.
Input: PR list from user.
Output: Classification table and prioritized gap summary. Each PR is classified as: docs present, docs needed, docs update needed, or no docs required.
Present the table to the user. Confirm which PRs to proceed with before moving to step 2.
Run .claude/skills/docs-pr-write/SKILL.md.
Input: Only PRs classified as "docs needed" or "docs update needed" from step 1, plus gap notes and suggested target files.
Output: Updated doc files, PR-to-doc mapping, and any open items needing engineering clarification.
Present the list of changed files. Ask the user to review before continuing to step 3.
Run .claude/skills/docs-review/SKILL.md on the files changed in step 2.
Input: File paths from step 2, plus any uncertain claims flagged during writing.
Output: Review report covering style guide compliance, frontmatter, links, and accuracy.
Present findings. After addressing review feedback, ask: "Would you like me to create a PR, or would you prefer to review the changes locally first?"
Each step passes forward:
| From | To | What passes |
|---|---|---|
| Step 1 → Step 2 | PR number, classification, gap notes, suggested target files | |
| Step 2 → Step 3 | Changed file paths, open items or uncertain claims |
| Task | Use |
|---|---|
| PRs shipped and need docs | This workflow (/docs-workflow) |
| New feature or product docs from scratch | Writer-agent (.agents/doc-agents/writers/writer-agent.md) |
| General documentation work not tied to PRs | Writer-agent |
.agents/doc-agents/shared/docs-context-guide.md.agents/doc-agents/shared/style-guide.md.agents/doc-agents/shared/verification-checklist.md