Generate markdown documentation mirroring source code directory structure.
npx skills add https://github.com/LayerDynamics/Lore --skill doc-writer-layerdynamics
Please help me install this Agent Skill. Skill: doc-writer Source: https://github.com/LayerDynamics/Lore/tree/main/lore/skills/doc-writer Command: npx skills add https://github.com/LayerDynamics/Lore --skill doc-writer-layerdynamics
This Skill automates the creation and maintenance of code documentation, ensuring that documentation accurately reflects the source code and follows a consistent structure.
Use the doc-writer skill to document the code in the 'src/utils' directory.
High-intent search queries and answers about installing and using this skill.
Markdown documentation is generated by scanning source files, extracting function, class, and parameter details, and writing markdown files in a mirrored directory structure. This ensures all documented elements are verifiable directly in the source code.
Yes, you can generate API docs that mirror your source code directory structure. The skill creates corresponding markdown documentation files that replicate the exact hierarchy of your source directories, keeping documentation organized alongside your codebase architecture.
Code documentation generation enforces a strict code-only truth policy, extracting information exclusively from source code content rather than inferring behavior. This ensures all documented elements remain fully verifiable within the actual source files.
The best way to keep API documentation synchronized is to regenerate markdown files directly from source. By mirroring the directory structure and extracting information exclusively from code content, the documentation accurately reflects the current source state.
A limitation when generating code docs from sparse source files is that documentation relies strictly on verifiable code content. Because it does not infer missing context or behavior, source files lacking explicit definitions may yield minimal markdown documentation.
chicanoandres702Extract functions, classes, modules, and dependencies into C4 code documentation with Mermaid diagrams.
mintlifyDraft and refine Markdown/MDX documentation within Mintlify-powered sites.
channgGenerate static documentation websites from markdown files with sidebar navigation.
RajuNaikGenerate OpenAPI specifications and endpoint documentation from source code.
