Analyze repositories to update documentation files from package manifests and configs.
npx skills add https://github.com/PaulRBerg/agent-skills --skill md-docs
Please help me install this Agent Skill. Skill: md-docs Source: https://github.com/PaulRBerg/agent-skills/tree/main/skills/md-docs Command: npx skills add https://github.com/PaulRBerg/agent-skills --skill md-docs
This skill helps keep project documentation synchronized with the actual codebase by updating README.md, CLAUDE.md, AGENTS.md, and CONTRIBUTING.md. It reduces drift between documentation and the codebase and minimizes manual editing.
Use cases:
Use the md-docs skill to update README.md, CLAUDE.md, AGENTS.md, or CONTRIBUTING.md. Start with a dry-run to preview changes: /md-docs:update-readme --dry-run
High-intent search queries and answers about installing and using this skill.
Documentation drift happens when code evolves but docs don't. This skill analyzes your repository structure, tooling, and dependencies to automatically update README.md, CLAUDE.md, AGENTS.md, and CONTRIBUTING.md, detecting changes from package manifests and config files so docs reflect your actual codebase.
Yes. The skill supports dry-run mode to show diffs before committing changes, and creates automatic backups of existing files. This lets you review exactly what will update and safely test changes without altering your original documentation.
Yes. The skill preserves user-authored sections when requested, applying only targeted updates to align with code changes. You control which parts stay manual and which get refreshed, avoiding loss of custom guidance or project-specific notes.
Use this after refactors, dependency upgrades, or structural changes to catch documentation that no longer matches reality. It's also useful for auditing inconsistencies between code and docs, and for initializing documentation on new projects.
The skill updates Markdown files (README.md, CLAUDE.md, AGENTS.md, CONTRIBUTING.md) by reading package manifests and config files like package.json, pyproject.toml, and similar tooling files to extract project metadata for accurate documentation.
It scans your repository for package manifests, config files, and project structure to identify tooling, workflows, and dependencies. From this information, it generates precise updates that reflect your actual setup without manual intervention.
spencerbeggsAnalyze repository file structures to determine project type and technical metadata.
microsoftPackage wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.
4IRLStage git changes, generate commit messages, and resolve pre-commit hook failures.
mirkoserticUpdate Megahub README, BLOCKS.md, HUBAPI.md, and LUMP.md documentation.
