Update repository documentation with overviews, interface examples, Mermaid diagrams, and references.
npx skills add https://github.com/matteing/opal --skill docs-matteing
Please help me install this Agent Skill. Skill: docs Source: https://github.com/matteing/opal/tree/main/.claude/skills/docs Command: npx skills add https://github.com/matteing/opal --skill docs-matteing
Keeps the repository's docs/ directory current and accurate so that explanations, interfaces, and architecture descriptions do not drift from the codebase as features are added, changed, or removed.
Use the docs skill to update or create the docs/ explainer for a changed or new feature, including a one-paragraph overview, interface examples, a how-it-works section, Mermaid diagrams, and references.
High-intent search queries and answers about installing and using this skill.
To keep project documentation accurate when adding features, update the docs directory to reflect current behavior. This ensures architecture descriptions and interface examples do not drift from the codebase as the project evolves.
Organize technical writing in a repository by enforcing a consistent format with one-paragraph overviews, interface examples, how-it-works sections, Mermaid diagrams, and references. This prescribed file organization keeps developer documentation evergreen.
Generate Mermaid diagrams for architecture documentation by creating or revising how-it-works sections within the docs directory. These diagrams visually explain subsystem behavior and ensure architecture descriptions match the codebase.
You need to update docs for a pull request when the changes modify behavior described in existing documentation. Revising the touched pages ensures the explainer remains evergreen and accurately reflects the new codebase behavior.
Yes, this documentation style guide works for new developer tools by creating explainer pages under the docs/tools directory. It enforces a consistent format including overviews, interface examples, and references for each tool.
mthinesAnalyze git diffs to identify and update outdated documentation.
JongsixGenerate technical documentation from source code and API definitions.
fuzzy-dynamicsGenerate and validate Markdown documents with Mermaid diagrams using templates.
chad3814Adds evergreen, explanatory comments to complex Rust code and workflows.
