Skip to main content
hc
Submit
commandsSource-backedReview first Safety ✓ Privacy ✓

/documentation-refresh - Documentation Refresh Runbook

Community slash command runbook to refresh stale project documentation after code changes: use git history to find affected docs, compare README commands to package scripts, and flag broken internal links before opening a docs PR.

by kiannidev·added 2026-06-16·
Claude Code
HarnessClaude Code
Invocation:/documentation-refresh [since-ref]
Review first — review before installing

Open the source and read safety notes before installing.

Safety notes

  • Read-only git history inspection unless the operator approves doc edits.
  • Validate git refs before interpolating them into shell commands.

Privacy notes

  • Commit messages and doc drafts enter model context; scrub internal-only details first.

Prerequisites

  • Git repository with commits and documentation files such as README.md or docs/.
  • Lockfiles or package manifests when comparing documented install commands.

Schema details

Install type
cli
Troubleshooting
No
Source repository stats
Scope
Source repo
Runtime and command metadata
Command syntax
/documentation-refresh [since-ref]
Full copyable content
/documentation-refresh [since-ref]

About this resource

Scope

This is a community custom entry you add under .claude/commands/ or .claude/hooks/. It is not a built-in Claude Code feature named on code.claude.com.

The /documentation-refresh runbook helps maintainers update docs after code changes using git history commands documented on git-scm.com. It is a custom .claude/commands/ workflow, not a built-in Claude Code feature.

Usage

/documentation-refresh [since-ref]
  • With since-ref: analyze commits after that tag or commit.
  • Without an argument: use the latest release tag from git describe --tags --abbrev=0.

What it does

When you invoke this command, follow these steps:

  1. Validate the ref. Reject refs with shell metacharacters, then verify with git rev-parse --verify --quiet <ref>^{commit}.
  2. List doc-touching commits. Run git log <ref>..HEAD --name-only --pretty=format:%h%x09%s and collect commits that modify README.md, docs/, or *.mdx sources.
  3. Find code changes needing doc updates. Run git diff <ref>..HEAD --stat and flag user-visible changes (CLI flags, scripts, env vars, breaking API paths) without matching doc edits in the same paths.
  4. Compare README commands to manifests. Extract fenced bash blocks from README and compare npm/pnpm/yarn script names to package.json scripts keys; list mismatches.
  5. Check internal links. Grep markdown for relative links and confirm target paths still exist in the working tree.
  6. Draft a refresh plan. Produce a prioritized checklist of doc files, sections to rewrite, and links to fix before opening a docs PR.

Output format

  • Range analyzed and commit count
  • Doc files already touched vs missing updates
  • README/script mismatches
  • Broken internal links
  • Recommended edit order for the docs PR

Source Verification Notes

Verified against Git documentation on 2026-06-16:

  • git log [<revision-range>] shows commits reachable from HEAD within an optional range such as <ref>..HEAD.
  • --name-only with git log lists paths changed by each commit.
  • git diff [<options>] <commit> <commit> shows file-level changes between two points in history, supporting stale-doc detection after releases.
  • git rev-parse --verify validates that a ref resolves before use in history commands.

Duplicate Check

/docs in content/commands/ is a broad documentation generator. No command documents this git-history-driven documentation refresh maintainer runbook.

#documentation#git#maintainer#slash-command

Source citations

Add this badge to your README

Show that /documentation-refresh - Documentation Refresh Runbook is listed on HeyClaude. Paste this Markdown into your README — it renders the badge and links back to this page.

Listed on HeyClaude
[![Listed on HeyClaude](https://heyclau.de/badge/commands/documentation-refresh.svg)](https://heyclau.de/entry/commands/documentation-refresh)

How it compares

/documentation-refresh - Documentation Refresh Runbook side by side with 3 alternatives on trust, install, platform support, and disclosed safety notes — all from reviewed registry metadata.

Field/documentation-refresh - Documentation Refresh Runbook

Community slash command runbook to refresh stale project documentation after code changes: use git history to find affected docs, compare README commands to package scripts, and flag broken internal links before opening a docs PR.

Open dossier 		/frontend-visual-qa - Chrome Design Verification Runbook

Community slash command runbook for frontend visual QA using documented Claude Code Chrome integration workflows: enable /chrome, open a local page, read console messages, and follow the design verification checklist from the Chrome integration guide.

Open dossier 		/mcp-smoke-test - MCP Server Verification Runbook

Community slash command runbook for post-install MCP verification using only documented Claude Code MCP commands: claude mcp list, claude mcp get, and the /mcp panel for authentication status before exercising a read-only tool.

Open dossier 		/openapi-diff-review - Spectral OpenAPI Diff Review Runbook

Community slash command runbook for OpenAPI contract review: lint base and head spec files with the documented Spectral CLI, compare rule failures, and classify release impact before merging API changes.

Open dossier
Trust
Install riskReview firstReview firstReview firstReview first
Notes Safety ✓ Privacy ✓ Safety ✓ Privacy ✓ Safety ✓ Privacy ✓ Safety ✓ Privacy ✓
Categorycommandscommandscommandscommands
Sourcesource-backedsource-backedsource-backedsource-backed
Authorkiannidevkiannidevkiannidevkiannidev
Added2026-06-162026-06-162026-06-162026-06-16
Platforms
Claude Code
Claude Code
Claude Code
Claude Code
Source repo————
Safety notes✓Read-only git history inspection unless the operator approves doc edits. Validate git refs before interpolating them into shell commands.✓Chrome integration runs in a visible browser with your logged-in session; avoid production admin flows. Handle login pages and CAPTCHAs manually when the integration pauses.✓Prefer read-only tools during verification; avoid destructive MCP tools on production data. Remove failing servers from MCP config before sharing logs externally.✓Read-only lint comparison; does not deploy APIs or mutate service configuration. Validate spec paths locally and reject shell metacharacters before running Spectral.
Privacy notes✓Commit messages and doc drafts enter model context; scrub internal-only details first.✓Console logs and screenshots may include staging data; redact before external sharing.✓MCP tool outputs may include repository paths; redact before posting publicly.✓OpenAPI files may describe internal hostnames or auth schemes; redact before external sharing.
Prerequisites
  • Git repository with commits and documentation files such as README.md or docs/.
  • Lockfiles or package manifests when comparing documented install commands.
  • Claude Code 2.0.73+ and Claude in Chrome extension 1.0.36+ on Chrome or Edge.
  • Local dev server reachable from the operator browser session.
  • Server already added with claude mcp add or present in project .mcp.json.
  • Non-production credentials when testing OAuth or remote MCP servers.
  • @stoplight/spectral-cli installed locally or via project devDependencies.
  • OpenAPI 3.x YAML or JSON spec files checked into the repository.
Install
/documentation-refresh [since-ref]
/frontend-visual-qa <route-or-host>
/mcp-smoke-test [server-name]
/openapi-diff-review <base-spec> <head-spec>
Config————
Citations
ClaimUnclaimedUnclaimedUnclaimedUnclaimed

Signals

Loading live community signals…

More like this, weekly

A short, calm digest of reviewed Claude resources. Unsubscribe any time.