Loading...
Loading...
Found 8 Skills
Documentation generation patterns for technical specs, API docs, user guides, and knowledge bases using real tools like Sphinx, MkDocs, TypeDoc, and Nextra. Use when creating docs from code, building doc sites, or automating documentation workflows.
Fix errors and warnings in Sphinx docs build
Document undocumented public APIs in PyTorch by removing functions from coverage_ignore_functions and coverage_ignore_classes in docs/source/conf.py, running Sphinx coverage, and adding the appropriate autodoc directives to the correct .md or .rst doc files. Use when a user asks to remove functions from conf.py ignore lists.
Systematic documentation authoring workflow for AI coding agents. Analyzes repositories to determine what documentation is needed, classifies each document by Diataxis type (tutorial, how-to, reference, explanation), and generates accurate, maintainable documentation that stays synchronized with the codebase. Handles greenfield projects (no docs exist), brownfield updates (refresh, enhance, rewrite existing docs), and doc audits with workflow-specific guidance for each. Use when the user requests documentation for a project: README creation, API reference, architecture docs, developer guides, changelogs, or any technical writing tied to a codebase. Also use when existing docs need auditing, updating, rewriting, or restructuring. Triggers on phrases like "write a README", "document this project", "API reference", "architecture doc", "developer guide", "getting started guide", "tutorial", "how-to", "audit our docs", "what docs are missing", "refresh the docs", "Diataxis", "doc the public API", "write a CHANGELOG", "explain this codebase", "onboarding doc", or "ADR". Triggers when creating or editing `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `docs/`, `mkdocs.yml`, `docusaurus.config.*`, `sphinx`/`conf.py`, ADRs, or any markdown file paired with code. Triggers when public APIs, CLI flags, configuration options, or environment variables change and the user wants the docs kept in sync. Do NOT use for standalone prose, marketing copy, blog posts, design documents, RFCs unrelated to a codebase, or documents where the source of truth is not source code.
Write docstrings for PyTorch functions and methods following PyTorch conventions. Use when writing or updating docstrings in PyTorch code.
Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. Do NOT use for: bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, performance tuning, or any task that does not involve writing or updating documentation.
Create and maintain technical documents, API documents, code comments, and project documents. Use this when you need to generate, update, or improve documentation.
Guide for following MassGen's release documentation workflow. This skill should be used when preparing release documentation, updating changelogs, writing case studies, or maintaining project documentation across releases.