doc-elisp

What problem does it solve?

This Skill automates the creation and updating of comprehensive documentation for Emacs Lisp packages, ensuring a consistent, high-quality standard aligned with established best practices.

Core Features & Use Cases

• Automated Documentation Generation: Creates or updates .org files for Elisp packages, adhering to a specific manual style.
• Definition Extraction: Identifies and documents user options, public variables, commands, and public functions from .el files.
• Structural Analysis: Compares existing documentation with source code to identify additions, removals, or changes in definitions.
• Use Case: You have developed a new Emacs Lisp package and need to create its official documentation, including an overview, user options, commands, and functions, formatted according to a rigorous standard.

Quick Start

Use the doc-elisp skill to create or update the documentation for the 'my-package.el' file.