Generate and maintain project documentation with README and docs/ directory.
npx skills add https://github.com/drsapaev/final --skill aif-docs-drsapaev
Please help me install this Agent Skill. Skill: aif-docs Source: https://github.com/drsapaev/final/tree/main/.codex/skills/aif-docs Command: npx skills add https://github.com/drsapaev/final --skill aif-docs-drsapaev
This Skill automates the creation and maintenance of project documentation, ensuring a consistent and user-friendly experience for developers and users alike.
docs/ directory.Use the aif-docs skill to generate documentation for the current project.
High-intent search queries and answers about installing and using this skill.
Generate project documentation by creating a lean README landing page and a detailed docs/ directory split by topic. This enforces specific principles for README structure, doc file navigation, and cross-linking to ensure a consistent developer experience.
Maintain project documentation by auditing existing README and docs/ directories. The process supports various documentation states, updating content organization and cross-links while enforcing best practices for file navigation and structural separation.
Yes, HTML generation is supported as an option during the documentation creation process. This allows you to convert the structured markdown files in your docs/ directory into web-ready formats alongside the standard README output.
Automated documentation enforces clear separation of information between the README and detailed documentation files. The README serves strictly as a lean landing page, while the docs/ directory contains the in-depth, topic-specific technical content.
No, you do not need an existing docs folder. The generation process supports projects starting from scratch with no documentation, as well as projects with existing README and docs/ directories that require auditing and maintenance updates.
samuerioGenerate README.md files from repository source code and metadata.
AIGNE-ioPublish Doc-Smith documentation to cloud or existing websites.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
zenobi-usAutomate API documentation creation and maintenance with OpenAPI integration.