docs-workflows

Plugin docs-workflows from marketplace shipwright in ihudak/ai-workflows. Commands read from the repo's manifest — today.

Skills (1)

• docs-frontmatter

  Apply documentation-page frontmatter conventions — changelog entries and page owners — when creating or editing a docs page under any content root declared by the applicable docs profile (an in-repo .dev-workflows/docs-profile.yml, else the built-in default). Use whenever you change a documentation

Slash commands (7)

• /docs-workflows:docs-audit

  Finds what documentation a product is missing and writes a prioritised backlog: scans the profiled code repositories and the specs tree into documentation surfaces, crosses each with the page types it earns, ranks the units with a written reason, and proposes tutorial candidates for a human to pick.

• /docs-workflows:docs-brand

  Applies a product's own logo and primary/accent colours to its Material for MkDocs site: extracts them from the code by a fixed precedence, prints each value with its file and line before applying it, checks WCAG 2.2 contrast, and copies the assets into docs/assets/. Use to rebrand an existing site

• /docs-workflows:docs-init

  Scaffolds a documentation repository for a project that has none: a Material for MkDocs skeleton with a stub in every section, public and internal builds over one content root, a generated nav, Vale, a CI workflow, and the docs-profile.yml the other docs commands read. Use once, on a repository with

• /docs-workflows:docs-profile

  Scan a documentation repository and write/refresh a machine-readable docs-profile (.dev-workflows/docs-profile.yml) plus complementary CLAUDE.md guidance, as a reviewable PR. Captures content roots, per-space dev-servers and lint/build/format commands, templating tokens, links, announcement pages, b

• /docs-workflows:docs-serve

  Start, stop or check the documentation site's dev server for a profiled docs repo, and report a URL that actually opens from the host. Reads the profile's dev_servers block; never starts a second server on a port that already answers; where the server's command carries the {port} token, falls forwar

• /docs-workflows:document

  keyed feature-documentation workflow. Phase 0 preflight-discovers the docs repo + profile (in-repo → built-in example-docs default → on-demand /docs-profile) and the PRD's specs dir under /workspace. Reads a Product Requirements Document hierarchy from its PRD folder in the specs tree — the folder t

• /docs-workflows:release-notes

  Release-notes drafting. Reads the Product Requirements Document from its PRD folder in the specs tree — the folder the address resolves to, or the one above it for an Epic address — optionally grounds in the recorded refs' diffs, renders an example-docs release-notes body, runs a light prose-style-c

Subagents (11)

• diff-summarizer

  Reads a single code repository's recorded refs and returns a documentation-focused summary. Pure local git — it takes each ref's diff in the clone and makes no HTTPS / REST call to a forge. Designed for parallel invocation (one instance per repo, capped at 4 concurrent by the caller). Model tier ass

• doc-location-finder

  Finds the right place(s) in a docs repository to write new or extended documentation for a feature. Returns a prioritised list of write targets (extend-existing, new-page-in-existing-section, new-section) with rationale. Heuristic + grep work; no content written. Model tier assigned by the caller pe

• doc-planner

  Synthesises PRD content, per-repo diff summaries, and confirmed write targets into a documentation checklist the writer follows and the reviewer checks against. Detects the repo's image policy (local vs CDN-upload) and annotates per-screenshot placement. Does NOT write content. Model tier assigned b

• doc-reviewer

  Reviews product documentation written by /document for correctness, completeness, and fitness for purpose. Returns PASS / PASS WITH RECOMMENDATIONS / BLOCK. Uses Claude Opus. Epic drafts are reviewed by epic-reviewer (a separate agent); this reviewer is product-docs-only.

• doc-writer

  Writes product documentation for /document from a structured handoff file — applies the doc-planner checklist, discrepancy decisions, snippets, screenshots, frontmatter, and internal links. Write-only (no git). Returns the list of files written. The orchestrator pins it to the §2 Opus reasoning chai

• docs-audit-reviewer

  Reviews the documentation backlog written by /docs-audit — the surfaces it enumerated, the units it crossed out of them, the reason under every priority, and the pairs of fields no single-field check can see. Returns PASS / PASS WITH RECOMMENDATIONS / BLOCK. Uses Claude Opus. Documentation prose is

• docs-auditor

  Enumerates a product's documentation surfaces from what a batch of code-scanner runs returned and from the specs-tree read, with volatility measured from git log density at the scanned ref. Returns surfaces[] plus the themes the scan could not settle, named rather than flattened into gaps. Assigns n

• docs-scaffold-reviewer

  Reviews the documentation-repository scaffold written by /docs-init and /docs-brand — the mkdocs configs, the generated nav, .vale.ini, the CI workflow and the theme CSS. Returns PASS / PASS WITH RECOMMENDATIONS / BLOCK. Uses Claude Opus. Product documentation prose is reviewed by doc-reviewer; this

• docs-style-checker

  Runs the docs repository's own prose linter (Vale, a lint script, markdownlint or remark, detected from the repository) on the files /document wrote, plus prose-style-checker as a semantic, cross-page pass — the fallback where every linter failed and the only check where none is configured — and mer

• ia-planner

  Crosses each enumerated documentation surface with the page types it actually earns, ranks the resulting units on the four prioritisation signals with a written reason naming them, and proposes tutorial candidates for a human to pick. Returns units[] and tutorial_candidates[]. Asks no question, writ

• release-notes-writer

  Renders the authored body of a release-notes draft for a resolved PRD or ticket from the folder read, optional diff summaries and optional conformance entries: exactly one Summary, shaped by its destination (breaking-changes, feature-updates or fixes), the category label from release_notes_category

Hooks (2)

• UserPromptSubmit

  bash "${CLAUDE_PLUGIN_ROOT}/hooks/preload-context.sh"

• PostToolUse

  bash "${CLAUDE_PLUGIN_ROOT}/hooks/changelog-owners-reminder.sh"

Similar plugins