doc-maintenance

Audit top-level documentation against git history and open a PR with minimal edits.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Mothership-Foundry/foundry-dashboard --skill doc-maintenance-mothership-foundry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/Mothership-Foundry/foundry-dashboard/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/Mothership-Foundry/foundry-dashboard --skill doc-maintenance-mothership-foundry

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit top-level documentation (README, SPEC, PRODUCT) against recent git history to find drift — shipped features missing from docs or features listed as upcoming that already landed. Proposes minimal edits, creates a branch, and opens a PR. Use when asked to review docs for accuracy, after major feature merges, or on a periodic schedule.

Core Features & Use Cases

  • Detect documentation drift between docs and code releases.
  • Propose minimal edits and automatically scaffold a PR workflow.
  • Target Documents: README.md, doc/SPEC.md, and doc/PRODUCT.md to ensure accuracy across core docs.

Quick Start

Run the doc-maintenance skill to scan README.md, doc/SPEC.md, and doc/PRODUCT.md for drift and propose minimal edits.

Frequently Asked Questions about doc-maintenance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift against recent git history?

To detect documentation drift, audit top-level files like README.md and SPEC.md against recent git history. This identifies shipped features missing from docs or outdated upcoming features, proposing minimal edits to resolve inconsistencies.

What is the best way to update README and SPEC files after a major feature merge?

The best way to update README and SPEC files after a major feature merge is to run an audit that enforces a minimal-patch workflow, creates a dedicated branch, and opens a pull request with the proposed documentation edits.

Can I automatically create a branch and open a PR for documentation updates?

Yes, you can automatically create a branch and open a PR for documentation updates. The workflow scaffolds the branch, applies minimal patches to README.md, doc/SPEC.md, and doc/PRODUCT.md, and submits the pull request.

How does a minimal-patch workflow work for documentation audits?

A minimal-patch workflow for documentation audits works by comparing top-level docs against git history and proposing only the smallest necessary edits to fix drift. It updates the review cursor and reports findings before opening a PR.

Do I need to manually review changes before the PR is opened?

You do not need to manually review changes before the PR is opened because the workflow proposes minimal edits and reports its findings automatically. However, reviewing the generated pull request ensures the documentation updates align with your project context.