code-documentation
TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)
Works with
--- name: code-documentation description: TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project) license: ISC --- # Code Documentation Skill ## Purpose This skill provides TSDoc format templates, type documentation guidelines, and maintenance workflows. Use this when: - Writing or editing TSDoc comments for any function, type, or module - Reviewing documentation quality - Creating comprehensive API documentation - Documenting complex type structures - Cleaning up non-compliant comments (performance notes, timestamps, inline explanations) - Synchronizing out-of-sync TSDoc with code changes - Removing orphaned documentation for deleted code **Key Standard**: No `@example` sections - tests and stories serve as living examples. ## Quick Reference - **Creating TSDoc**: See [workflow.md](references/workflow.md) for the generation workflow - **Maintaining TSDoc**: See [maintenance.md](references/maintenance.md) for cleanup and sync guidelines This skill contains detailed templates for: - Public API Functions - Internal Module Documentation - Public and Internal Types - Helper Functions - Behavioral Programming Functions - Special Annotations (Security, Performance, Deprecated) - Type Documentation (Complex Objects, Unions, Functions, Utilities, Branded Types, etc.) ## Navigation - [workflow.md](references/workflow.md) - TSDoc generation workflow (4 phases) - [maintenance.md](references/maintenance.md) - Comment policy, sync tasks, orphaned doc handling - [public-api-templates.md](references/public-api-templates.md) - Templates for public-facing APIs - [internal-templates.md](references/internal-templates.md) - Templates for internal code and modules - [type-documentation.md](references/type-documentation.md) - Comprehensive type documentation templates ## Related Skills - **typescript-lsp**: Use for type verification and discovery during documentation workflow. Essential for Phase 1 (type analysis) and Phase 2 (usage discovery) of the TSDoc generation process. Run `lsp-hover` to verify signatures, `lsp-references` to find usages, and `lsp-symbols` to understand file structure.
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
