Generate PR narratives and add rustdoc documentation for code changes.
npx skills add https://github.com/fcoury/config --skill documentation-pass
Please help me install this Agent Skill. Skill: documentation-pass Source: https://github.com/fcoury/config/tree/main/ai/skills/document-pass Command: npx skills add https://github.com/fcoury/config --skill documentation-pass
This Skill addresses the challenge of making complex code changes understandable to human reviewers and maintainers, ensuring clarity without altering runtime behavior.
Use the documentation-pass skill to generate a PR description and add rustdoc comments for the recent changes in the src/ directory.
High-intent search queries and answers about installing and using this skill.
Generating a PR description involves performing a documentation pass on recent changes. This creates a narrative covering the problem, mental model, architecture, tradeoffs, and tests, making complex refactors easier for reviewers to understand.
Adding rustdoc comments is achieved through a non-functional documentation pass. This process adds or updates module, type, and function-level documentation to clarify design and guarantees without altering runtime behavior.
To surface implicit contracts, you perform a documentation pass. This process identifies and categorizes implicit invariants, making them explicit in the documentation to improve long-term project understanding and maintainability.
Improving code readability without altering runtime behavior is possible through a non-functional documentation pass. This process enhances human readability by adding in-code documentation and surfacing design risks without changing functional output.
This documentation pass is primarily used for code review enhancement. It improves reviewability by generating PR narratives and adding module documentation, ensuring complex changes are clear to human reviewers and maintainers.
carl10086Simplify source code by reducing structural complexity and improving readability.
fzymgc-houseList, acknowledge, and respond to GitHub PR review comments.
aniruddh2003Run static analysis tools to detect security vulnerabilities, type errors, and linting issues.
matsenVerify factual claims in PR reviews against code, tests, and commits.
