aif-docs

Generate and maintain project documentation with a lean README and topic-split docs directory.

31|2|Updated Mar 21, 2026
One-click install
npx skills add https://github.com/letuhao/lore-weave --skill aif-docs-letuhao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aif-docs
Source: https://github.com/letuhao/lore-weave/tree/main/.cursor/skills/aif-docs
Command: npx skills add https://github.com/letuhao/lore-weave --skill aif-docs-letuhao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Project documentation often becomes a bloated README or scattered markdown files that are hard to navigate and quickly go stale. This Skill structures documentation into a landing-page README plus a docs directory with one self-contained page per topic, complete with navigation links and review checklists. ## Core Features & Use Cases - Documentation Generation: Creates a lean README (80-120 lines) plus topic pages like getting-started, architecture, API reference, and configuration in the docs directory. - Restructuring & Auditing: Splits oversized READMEs, consolidates scattered root-level markdown files, and audits existing docs for broken links, stale content, and missing navigation. - HTML Site Export: With the --web flag, converts all markdown docs into a static HTML site using a built-in template. - Use Case: A project with a 400-line README and loose CONTRIBUTING.md and DEPLOYMENT.md files gets reorganized into a concise README, a linked docs/ directory, and an optional browsable HTML site. ## Quick Start Ask the AI to generate documentation for this project, or to audit and improve the existing README and docs directory.

Frequently Asked Questions about aif-docs

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

FAQPage Schema
How do I generate documentation for my project automatically?

Invoke the skill with a request like "create docs" or "generate readme". It analyzes your codebase, proposes documentation topics such as getting-started and architecture, and generates a lean README plus linked pages in the docs directory after your approval.

How to split a long README into multiple documentation pages?

The skill detects READMEs over 150 lines and proposes a split: landing content stays in README while detailed sections move to docs/ pages like getting-started.md and configuration.md. It shows the plan and asks for approval before executing.

Can I convert markdown documentation to an HTML site?

Yes, pass the --web flag to generate a static HTML site in docs-html/ from README.md and all docs pages. It uses a built-in HTML template with navigation and converts .md links to .html automatically.

Does it handle scattered markdown files in the project root?

Yes, it scans for root-level files like CONTRIBUTING.md, ARCHITECTURE.md, and DEPLOYMENT.md, then proposes moving or merging them into the docs directory. Originals are only deleted after explicit user confirmation.

Will it overwrite my existing documentation without asking?

No, the skill always shows a plan and requests approval before changing existing docs. It never deletes content without relocating it, preserves badges and logos, and verifies no content is lost during restructuring.