Imported from jimmypaolini/codebase (.agents/skills/refresh-documentation/SKILL.md). Install upstream with npx skills add jimmypaolini/codebase --skill refresh-documentation. Copyright stays with the author (MIT).

Refresh Documentation

This skill guides a systematic review and refresh of all documentation across the codebase. It is also invoked automatically each week by the refresh-documentation GitHub Actions workflow, which creates a GitHub issue assigned to Copilot.

When to Use This Skill

• When asked to "refresh documentation", "update docs", or "audit documentation"
• When documentation may be stale after significant code changes
• On the weekly scheduled cadence (triggered automatically via GitHub issue)

Scope

Documentation to review and update:

Step-by-Step Workflow

Phase 1 — Audit

For each path in scope, read the documentation and cross-check it against the actual codebase. Classify every finding into one of three categories:

Phase 2 — Act

1. Remove deprecated content — Delete sections, files, or entries that document things that no longer exist. This includes dead links, removed commands, retired projects, and superseded conventions.

2. Update outdated content — Fix inaccurate content by cross-checking against actual source files:

   • Code examples: verify commands, file paths, and APIs against the codebase
   • README files: check that project structure, commands, and purpose are accurate
   • AGENTS.md files: verify quick-reference commands still work and descriptions match current conventions
   • Cross-references: fix broken internal links

3. Create missing documentation — Write new content for undocumented areas:

   • New projects added since the last documentation refresh
   • New conventions, tools, or workflows not yet documented
   • Features documented in code comments but absent from markdown docs

References

• AGENTS.md — Workspace-level instructions
• documentation/ — Core documentation directory