doc-maintenance

Compare documentation against recent git commits and generate a pull request.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/elijahbowie/ArchonOS --skill doc-maintenance-elijahbowie
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/elijahbowie/ArchonOS/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/elijahbowie/ArchonOS --skill doc-maintenance-elijahbowie

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audits top-level documentation against recent git history to detect drift between README, SPEC, and PRODUCT, and suggests minimal, non-disruptive edits.

Core Features & Use Cases

  • Detect drift between top-level docs and recent commits to surface inaccuracies.
  • Build concise change summaries, create feature branches, and open PRs with minimal edits.
  • Ensure doc cursor is updated after review to track progress across cycles.

Quick Start

Run the doc-maintenance workflow to audit docs, generate a change plan, and push a PR containing only factual fixes.

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 between my README and recent git commits?

Documentation drift is detected by comparing current top-level docs against recent git history. This audit surfaces inaccuracies in your README, SPEC, and PRODUCT files by analyzing recent commits and identifying where documentation no longer matches the codebase.

What is the best way to automate minimal fact-based edits to project documentation?

The best way to automate minimal fact-based edits is by running a doc audit workflow that builds concise change summaries. It creates a feature branch, applies non-disruptive factual edits to align docs with code, and generates a PR containing only the necessary fixes.

Can I generate a PR for documentation updates directly from my git workflow?

Yes, you can generate a PR for documentation updates directly from your git workflow. The audit process builds concise change summaries from recent commits, creates a feature branch, applies minimal edits to your docs, and opens a pull request containing the factual fixes.

How does a doc review cursor maintain a running baseline for future documentation audits?

A doc review cursor maintains a running baseline by updating its position after changes are applied. This tracking mechanism records progress across cycles, allowing future documentation audits to compare current docs against the correct historical commit baseline.

Does this documentation audit workflow support SPEC and PRODUCT files alongside the README?

Yes, the documentation audit workflow explicitly supports SPEC and PRODUCT files alongside the README. It identifies drift across all three top-level documentation files and proposes minimal, fact-based edits to bring them back into alignment with recent commits.