docs-maintain
Skill2 starsChanged 9 months agoApache-2.0View on GitHub
Check documentation sync and auto-update doc artifacts. Combines sync checking (template-instance validation) with update automation (index regeneration, cross-doc dependencies, archive verification).
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 6 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 23
When the task doesn't match this skill's scope -- check related skills
- Distinctive: line 24
When a more specialized skill exists for the specific task
- Very specific: line 51
No placeholder content remains ([e.g., ...], [X], [TODO], etc.)
- Distinctive: line 52
All relative links point to existing files
- Distinctive: line 87
After creating, moving, or deleting markdown files
- Very specific: line 88
When pre-commit blocks due to DOCUMENTATION_INDEX.md not staged
- Distinctive: line 89
Before multi-AI audits (ensure audit plans are synced)
- Distinctive: line 90
After updating templates (verify instances were updated)
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
<!-- prettier-ignore-start -->Document Version: 1.0 Last Updated: 2026-02-14 Status: ACTIVE
<!-- prettier-ignore-end -->Documentation Maintenance
Unified skill for checking doc sync and updating doc artifacts.
When NOT to Use
- When the task doesn't match this skill's scope -- check related skills
- When a more specialized skill exists for the specific task
Usage
/docs-maintain # Run both check + update
/docs-maintain --check # Check only (no changes)
/docs-maintain --update # Update only (regenerate + fix)Check Mode (from docs-sync)
Validate template-instance synchronization.
Execution
npm run docs:sync-check
# With details: npm run docs:sync-check -- --verbose
# As JSON: npm run docs:sync-check -- --jsonWhat It Checks
- Template-derived documents are properly synchronized
- No placeholder content remains (
[e.g., ...],[X],[TODO], etc.) - All relative links point to existing files
- Sync dates are recent (<90 days)
Exit Codes
- 0: All documents synced
- 1: Sync issues found
- 2: Error during check
Update Mode (from docs-update)
Auto-update documentation artifacts after file changes.
Execution
npm run docs:index && git add DOCUMENTATION_INDEX.mdWhat It Does
- Regenerate Documentation Index - runs
npm run docs:indexto update DOCUMENTATION_INDEX.md - Check Cross-Document Dependencies - reviews
docs/DOCUMENT_DEPENDENCIES.mdfor affected triggers - Verify Archive Requirements - checks moved docs have README.md in archive folders
- Suggest Updates - lists documents referencing moved/deleted files
When to Use
- After creating, moving, or deleting markdown files
- When pre-commit blocks due to DOCUMENTATION_INDEX.md not staged
- Before multi-AI audits (ensure audit plans are synced)
- After updating templates (verify instances were updated)
- After archiving documents
Related
DOCUMENTATION_INDEX.md- Auto-generated doc indexdocs/DOCUMENT_DEPENDENCIES.md- Cross-doc triggers and sync protocols- Pre-commit hook (step 8) - Doc index enforcement
Version History
| Version | Date | Description |
| 1.0 | 2026-02-25 | Initial implementation |
In this repository81 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- llms.txtllms.txt
- find-skillsSkill
- add-debtSkill
- alertsSkill
- analyzeSkill
- artifacts-builderSkill
- audit-agent-qualitySkill
- audit-aggregatorSkill
- audit-ai-optimizationSkill
- audit-codeSkill
- audit-comprehensiveSkill
- audit-documentationSkill
- audit-engineering-productivitySkill
- audit-enhancementsSkill
- audit-healthSkill
- audit-performanceSkill
- audit-processSkill
- audit-refactoringSkill
- audit-securitySkill
- brainstormSkill
- checkpointSkill
- code-reviewerSkill
- comprehensive-ecosystem-auditSkill
- content-research-writerSkill
- convergence-loopSkill
- create-auditSkill
- data-effectiveness-auditSkill
- debt-runnerSkill
- decrypt-secretsSkill
- deep-planSkill
- deep-researchSkill
- developer-growth-analysisSkill
- doc-ecosystem-auditSkill
- doc-optimizerSkill
- document-analysisSkill
- ecosystem-healthSkill
- Excel AnalysisSkill
- find-skillsSkill
- frontend-designSkill
- gh-fix-ciSkill
- github-healthSkill
- health-ecosystem-auditSkill
- hook-ecosystem-auditSkill
- market-research-reportsSkill
- mcp-builderSkill
- media-analysisSkill
- multi-ai-auditSkill
- pre-commit-fixerSkill
- pr-ecosystem-auditSkill
- pr-retroSkill
- pr-reviewSkill
- quick-fixSkill
- recallSkill
- repo-analysisSkill
- repo-synthesisSkill
- script-ecosystem-auditSkill
- session-beginSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

