agent-maintained-docs

Embed file header descriptions and folder READMEs enforced by git hooks.

37|8|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/mlopscommunity/Coding-Agents-Conference-skills --skill agent-maintained-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agent-maintained-docs
Source: https://github.com/mlopscommunity/Coding-Agents-Conference-skills/tree/main/skills/agent-maintained-docs
Command: npx skills add https://github.com/mlopscommunity/Coding-Agents-Conference-skills --skill agent-maintained-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common problem of outdated or missing documentation in codebases, which hinders navigation and understanding for both humans and AI agents.

Core Features & Use Cases

  • Automated Documentation Generation: Embeds documentation directly into source files (headers) and folders (READMEs).
  • Commit-Time Enforcement: Uses pre-commit hooks to ensure documentation is updated alongside code changes.
  • Use Case: When adding a new feature, this skill ensures that the relevant file headers and folder READMEs are updated simultaneously, making the codebase instantly navigable for any agent or developer.

Quick Start

Use the agent-maintained-docs skill to add header comments to all new files and update folder READMEs for any structural changes.

Frequently Asked Questions about agent-maintained-docs

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

FAQPage Schema
How do I keep documentation updated automatically when my codebase changes?

To keep documentation updated automatically, this skill embeds descriptions in file headers and folder READMEs, then validates them using git hooks to ensure docs change alongside code.

What is the best way to enforce documentation updates in a git workflow?

The best way to enforce documentation updates is using pre-commit hooks like husky or lefthook to validate that file headers and folder READMEs are modified whenever source code changes are committed.

How do pre-commit hooks validate file headers and folder READMEs?

Pre-commit hooks validate file headers and folder READMEs by checking if documentation was updated alongside code changes, failing the commit if navigational aids for AI agents and developers are outdated.

Do I need git hooks to use automated documentation generation?

Yes, you need git hooks for automated documentation generation enforcement, as this skill requires integration with tools like husky or lefthook to validate documentation currency at commit time.

Can I use this approach to make my codebase navigable for AI agents?

Yes, you can make your codebase navigable for AI agents by embedding descriptions in file headers and folder READMEs, providing navigational aids that help agents understand evolving source trees.