docs-readme

Generate a complete README in Markdown by analyzing repository structure and AGENTS.md.

1|Updated Aug 16, 2025
One-click install
npx skills add https://github.com/ReefBytes/Manifest --skill docs-readme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-readme
Source: https://github.com/ReefBytes/Manifest/tree/main/configs/claude/skills/docs-readme
Command: npx skills add https://github.com/ReefBytes/Manifest --skill docs-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

README files frequently become stale or inconsistent with the codebase, making onboarding and usage harder. This skill analyzes the repository structure, AGENTS.md, and existing docs to propose consistent, actionable README improvements.

Core Features & Use Cases

  • Analyze codebase and AGENTS.md to identify missing or outdated README sections.
  • Propose a structured README template and fill in real usage examples based on project files.
  • Generate a complete, copy-ready README tailored to the repository, with links, instructions, and highlights.

Quick Start

Provide the path to the target repository and run the skill to generate an improved README.

Frequently Asked Questions about docs-readme

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

FAQPage Schema
How do I generate a complete README from existing project structure and code?

To generate a README, analyze your repository structure, AGENTS.md, and existing docs to identify gaps, then apply a best-practice template to output a complete, copy-ready Markdown file with tailored sections and usage examples.

Why does my README have missing or outdated sections compared to the codebase?

README files frequently become stale or inconsistent with the codebase because manual updates are often skipped during development. Analyzing code context and project structure identifies these gaps and inconsistencies automatically.

Can I use AGENTS.md to improve documentation quality and consistency?

Yes, you can use AGENTS.md alongside existing docs and repository files to evaluate documentation quality, detect missing sections, and generate actionable improvements tailored to the project context.

What's the best way to fix inconsistent project documentation automatically?

The best way to fix inconsistent project documentation is to analyze code context and existing docs to identify gaps, then apply a best-practice structure to generate a complete, copy-ready README in clean Markdown.

Does the generated README include real usage examples based on project files?

Yes, the generated README includes real usage examples based on project files, along with structured sections, links, instructions, and highlights tailored specifically to your repository.

How to format the output of an automated README generator without code fences?

To format the output without code fences, the generator processes all configuration, validation, and formatting constraints internally and outputs the final documentation directly in clean Markdown.