action-project-docs

Generate and update README.md, CONTRIBUTING.md, and AGENTS.md from codebase analysis.

1|Updated Oct 5, 2025
One-click install
npx skills add https://github.com/simon-downes/agent-workspace --skill action-project-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: action-project-docs
Source: https://github.com/simon-downes/agent-workspace/tree/main/skills/action-project-docs
Command: npx skills add https://github.com/simon-downes/agent-workspace --skill action-project-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates generating and maintaining core project documentation (README.md, CONTRIBUTING.md, AGENTS.md) by analyzing codebase artifacts to keep content accurate and up-to-date.

Core Features & Use Cases

  • Generates README.md, CONTRIBUTING.md, and AGENTS.md based on codebase analysis
  • Updates existing docs with minimal changes and diff awareness
  • Applies to both single repositories and umbrella repos

Quick Start

Run the skill on a project workspace to generate or update README.md, CONTRIBUTING.md, and AGENTS.md based on codebase analysis artifacts.

Frequently Asked Questions about action-project-docs

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

FAQPage Schema
How do I auto-generate README and CONTRIBUTING docs from my codebase?

To auto-generate README.md and CONTRIBUTING.md from your codebase, you can use tools that analyze codebase artifacts to produce and maintain accurate project documentation automatically.

Can I update existing project documentation without rewriting the whole file?

Yes, updating existing project documentation can be done with minimal changes using diff-aware updates. This approach modifies README.md and CONTRIBUTING.md only where needed instead of rewriting the entire file.

What is an AGENTS.md file and when do I need it for my repository?

An AGENTS.md file provides non-obvious agent rules for your repository. You need it when you want to generate optional guidance alongside standard README.md and CONTRIBUTING.md files to assist automated agents.

Does codebase analysis for documentation work with umbrella repos?

Yes, codebase analysis for generating documentation works with both single repositories and umbrella repos. It analyzes the repository structure to update README.md and other docs as needed.

How do I maintain accurate project docs as my codebase evolves?

You maintain accurate project docs by applying diff-aware updates to existing files like README.md and CONTRIBUTING.md. This template-driven approach analyzes codebase artifacts to keep content current.

What is the best way to generate consistent documentation across multiple repositories?

The best way to generate consistent documentation across multiple repositories is using template-driven content generation. This applies diff-aware updates to README.md and CONTRIBUTING.md across single or umbrella repos.