doc-generator

To generate technical documentation from your codebase, this Skill analyzes your source code and utilizes provided templates to draft files like README.md, api.md, and architecture.md. It prioritizes discovering existing docs and updates them rather than creating new files.

The best way to update existing README.md and api.md files after adding new endpoints is using this Skill, which performs semantic search to locate relevant context within your codebase. It then updates the documentation with new endpoint details, request formats, and authentication requirements.

No, you cannot use this to generate inline code comments or general writing tasks. This Skill is invoked specifically when users request the creation, update, or audit of technical documentation files like database.md and auth.md, and is not intended for general writing or inline documentation.

No, this documentation generator utilizes provided templates to draft content after analyzing your codebase. It relies on these templates alongside semantic search to locate relevant context before creating or updating files like architecture.md.

You should not use an automated codebase analysis tool for documentation when you need inline code comments, general writing tasks, or formatting outside of README.md, api.md, auth.md, architecture.md, and database.md. It is strictly for auditing and updating these specific technical docs.