aif-docs

Generate Markdown project documentation with a landing README and topic-based docs.

Updated Apr 3, 2026
One-click install
npx skills add https://github.com/ExsyDev/eye-blinking --skill aif-docs-exsydev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aif-docs
Source: https://github.com/ExsyDev/eye-blinking/tree/main/.claude/skills/aif-docs
Command: npx skills add https://github.com/ExsyDev/eye-blinking --skill aif-docs-exsydev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates and maintains project documentation by creating a lean landing README plus a detailed docs/ directory split by topic, ensuring up-to-date guidance for new contributors and teams.

Core Features & Use Cases

  • Lean landing page README that explains purpose, setup, and links to docs.
  • Topic-based docs in docs/ to cover architecture, API, configuration, deployment, and workflows.
  • Consistent navigation templates with prev/next links and a See Also section for related topics.
  • Optional HTML output for hosting as a static docs site (--web).

Quick Start

Create a lean landing README and a docs/ directory with topic pages for a new project.

Frequently Asked Questions about aif-docs

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

FAQPage Schema
How do I generate project documentation with a landing README and navigable topic pages?

Generating project documentation creates a lean landing README plus a docs/ directory split by topic. It provides structured Markdown for architecture, API references, and configuration with prev/next navigation and See Also sections.

What is the best way to structure Markdown docs for a software project?

The best way to structure Markdown docs is using a lean landing page README for purpose and setup, linked to a docs/ directory with topic-based pages for architecture, deployment, and workflows, ensuring consistent navigation.

Can I output my Markdown documentation as a static HTML web site?

Yes, you can output Markdown documentation as a static HTML web site using the optional web output flag. This allows you to host the generated topic-based docs as a navigable static documentation site.

How do I add navigation links and related topic sections to my documentation?

Adding navigation links and related topic sections uses consistent templates that apply prev/next links between pages and a See Also section. This ensures readers can easily navigate between architecture and configuration topics.

Do I need any dependencies or frameworks to auto-generate lean documentation?

No dependencies or frameworks are required to auto-generate lean documentation. The process directly creates structured Markdown files for your README and topic pages without needing external components or setup.