update-docs

Overview

Update Docs is a skill from the Next.js repository that provides a guided workflow for updating Next.js documentation based on code changes. Designed for maintainers reviewing PRs for documentation completeness, it maps changed source files to their corresponding documentation paths and walks through updates with user confirmation and lint validation.

Key Features

• Code-to-Docs Mapping - Automatically maps changed source files to corresponding documentation paths using a reference mapping (e.g., image.tsx to image.mdx)
• Branch Diff Analysis - Analyzes git diff canary...HEAD to identify all documentation-relevant changes across packages, components, and configuration
• Guided Update Workflow - Five-step process: analyze changes, identify affected docs, review each doc, validate with pnpm lint, and commit documentation changes
• Router-Aware Content - Handles <AppOnly> and <PagesOnly> router-specific content blocks and frontmatter fields in documentation
• PR Documentation Completeness - Ensures new props, changed behaviors, deprecated features, and new examples are properly documented with migration guidance

Who is this for?

This is for Next.js maintainers and contributors who need to keep documentation in sync with code changes across pull requests. It is ideal for teams reviewing PRs who want a systematic approach to identifying which documentation needs updating when source code changes.