Generate JSDoc comments and README files for code modules.
npx skills add https://github.com/hypeJunction/ai-assistant-starter --skill docs-hypejunction
Please help me install this Agent Skill. Skill: docs Source: https://github.com/hypeJunction/ai-assistant-starter/tree/main/skills/docs Command: npx skills add https://github.com/hypeJunction/ai-assistant-starter --skill docs-hypejunction
This Skill addresses the challenge of maintaining clear, accurate, and comprehensive documentation for codebases, ensuring that the "why" behind the code is as well-understood as the "what."
Add JSDoc to all exported functions in the current directory.
High-intent search queries and answers about installing and using this skill.
You can automatically generate JSDoc for exported functions, classes, and interfaces by running this documentation tool. It adds or updates comments to explain parameters, return values, and usage examples.
The best way to create a README for a module is using this tool to generate or enhance the file. It ensures the documentation reflects recent code changes and clarifies the module's purpose.
Yes, you can add inline code comments to clarify complex logic. This tool focuses on explaining the reasoning behind the code rather than the mechanical steps, ensuring intent is clear.
Yes, this documentation tool supports targeting specific files or directories via flags. You can isolate JSDoc generation or README updates to exact paths instead of processing the entire project.
To document the 'why' behind code, this tool adds explanatory inline comments and JSDoc that focus on reasoning. It clarifies intent and provides usage examples for exported functions and modules.
htlin222Generate a semantic codebase symbol map with exact file:line locations.
icartshGenerate READMEs, changelogs, and API references from Git history.
klhGenerate and validate docstrings, JSDoc, and OpenAPI specs for Python, TypeScript, and Node.js projects.
nnkiennGenerate README, API, code comment, and AI-friendly documentation templates.
