skills.rest
iliaal
iliaalCOMMUNITY
Explore all skills by this author →
Website𝕏@iliaaGitHub

md-docs

Update AGENTS.md, README.md, and CONTRIBUTING.md to reflect codebase changes.

Updated May 2, 2026
Search Tags:#project management#documentation#codebase#readme#agents.md#contributing.md
One-click install
npx skills add https://github.com/iliaal/compound-engineering-plugin --skill md-docs-iliaal
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: md-docs
Source: https://github.com/iliaal/compound-engineering-plugin/tree/main/distillery/generated-skills/md-docs
Command: npx skills add https://github.com/iliaal/compound-engineering-plugin --skill md-docs-iliaal

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the management of essential project documentation like AGENTS.md, README.md, and CONTRIBUTING.md, ensuring they accurately reflect the current state of the codebase.

Core Features & Use Cases

  • Context File Management: Ensures AGENTS.md (and its symlink CLAUDE.md) is up-to-date with project structure, commands, and tooling.
  • README Generation/Update: Creates or refreshes README.md based on project metadata and detected stack.
  • CONTRIBUTING.md Updates: Modifies existing contribution guidelines for technical accuracy without creating new ones.
  • Use Case: After updating your project's build scripts, use this Skill to automatically update the AGENTS.md and README.md files to reflect these changes, keeping your documentation in sync.

Quick Start

Use the md-docs skill to update the project's README file.

Frequently Asked Questions about md-docs

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

FAQPage Schema
How do I automatically update project documentation like README.md to match my codebase?▼

To update project documentation, this Skill analyzes your codebase structure, configuration files, and commands to ensure README.md and AGENTS.md accurately reflect your current stack and build scripts.

Does this documentation management tool work with Python and TypeScript projects?▼

Yes, this documentation management tool works with Python and TypeScript projects, alongside PHP, JavaScript, PineScript, and Bash, by detecting your specific stack to maintain accurate project files.

What is the best way to keep AGENTS.md context files synchronized with new build commands?▼

The best way to keep AGENTS.md synchronized is to run this Skill after updating build scripts; it refreshes context files and their symlinks like CLAUDE.md to verify technical accuracy and relevance.

How to update CONTRIBUTING.md guidelines for technical accuracy without starting from scratch?▼

To update CONTRIBUTING.md guidelines, this Skill modifies existing contribution files for technical accuracy based on codebase analysis, but it does not create new contribution guidelines from scratch.

Can I use md-docs to initialize context files for an existing repository?▼

Yes, you can use md-docs to initialize context files for an existing repository, as it supports workflows for generating and updating AGENTS.md and README.md based on detected project metadata.

What limitations exist when refreshing README files for unsupported tech stacks?▼

A key limitation is that refreshing README files relies on detecting supported stacks like PHP, Python, JavaScript, TypeScript, PineScript, and Bash; unsupported environments may lack accurate automated metadata extraction.

Related Skills

Explore More Software Engineering Skills→
SteveFeldmanSteveFeldman
5

create-onboarding

Generate codebase-aware onboarding documentation from project configuration and structure.

Community
Advanced
zapierzapier
373

Git Commit

Generate Conventional Commits with Jira context and push changes.

Official
Advanced
kis9akis9a

doc-generator

Generate and update Go documentation from source code.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic