Generate and maintain project documentation with a README and docs/ directory.
npx skills add https://github.com/batFormat/sancrm-docs --skill aif-docs-batformat
Please help me install this Agent Skill. Skill: aif-docs Source: https://github.com/batFormat/sancrm-docs/tree/main/.claude/skills/aif-docs Command: npx skills add https://github.com/batFormat/sancrm-docs --skill aif-docs-batformat
This Skill automates the creation and maintenance of project documentation, ensuring a consistent and user-friendly structure.
docs/ directory by topic.Use the aif-docs skill to generate documentation for the current project.
High-intent search queries and answers about installing and using this skill.
To generate project documentation, this Skill analyzes your codebase and existing markdown files to create a lean README landing page alongside a detailed docs/ directory split by topic.
The best way to maintain markdown documentation is using workflow automation to audit and update existing files. This Skill manages the documentation lifecycle, ensuring your README and docs/ directory stay consistent with codebase changes.
Yes, you need bash, npx, and python installed to automate documentation generation. These dependencies are required for executing the scripts that manipulate files and split your project documentation by topic.
Yes, you can split a large README into a multi-file docs directory. The Skill generates a lean README as a landing page and organizes detailed information into separate topic-based files within the docs/ folder.
Project documentation automation works without existing markdown files by leveraging codebase analysis directly. It can initialize a new README and docs/ structure from scratch, though existing markdown enhances the audit and update workflow.
EmpoweredHouseAnalyze source files to extract structure and behavior for spec generation.
copilot-ldRender Markdown documentation into static HTML sites with Mustache templates.
ak110Synchronize toolchains and documentation across sister projects using a synchronization matrix.
channgGenerate static documentation websites from markdown files with sidebar navigation.