docs

Check that all code has appropriate documentation.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "docs" with this command: npx skills add seabbs/claude-code-config/seabbs-claude-code-config-docs

Check that all code has appropriate documentation.

Arguments: $ARGUMENTS (optional scope)

  • commit: Check only staged files

  • pr: Check all files changed in the current PR

  • all: Check the entire codebase

  • If no argument provided:

  • If in a PR branch: defaults to 'pr'

  • Otherwise: defaults to 'commit'

Phase 1: Scope Determination

  • Determine scope based on $ARGUMENTS

Phase 2: Documentation Analysis

  • Identify functions/classes lacking documentation

  • Check quality of existing documentation

  • Extract project documentation standards from CLAUDE.md

Phase 3: Documentation Updates

For identified gaps:

  • Generate documentation following project conventions

  • Apply language-specific formats (roxygen2, docstrings, JSDoc)

  • Use @inheritParams in R to avoid duplication

For R projects: Run devtools::document() to update man/ files

Phase 4: Quality Verification

  • Verify documentation format compliance and no broken references

Phase 5: Report Results

  • Summary of files checked, documentation added/updated, and remaining issues

Auto-Exit When Standalone

IMPORTANT: If this command is being run as a standalone request, automatically exit after completing all phases successfully.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

taskfile-automation

No summary provided by upstream source.

Repository SourceNeeds Review
1.2K-seabbs
Coding

analyzing-research-papers

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

academic-writing-standards

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

grant-compliance-checking

No summary provided by upstream source.

Repository SourceNeeds Review