How does it know which documentation files to update?

The skill analyzes your Git diff against the canary branch and uses a predefined mapping file to link source code changes in specific packages to their corresponding MDX files.

Does it support both App Router and Pages Router docs?

Yes, it specifically handles router-specific content using and tags and understands the directory structure for both architectures.

What happens if a doc uses shared content from another file?

The skill identifies the 'source' field in MDX frontmatter, guiding you to edit the original source file (usually the App Router version) instead of the linked copy.

Can it create documentation for entirely new features?

Absolutely. It includes scaffolding templates for API references, guides, config options, and file conventions to ensure new docs follow the project's standards.

Does this skill help with formatting and linting?

Yes, it includes built-in steps to run 'pnpm lint' and 'pnpm prettier-fix' to ensure all documentation changes meet the repository's style guidelines.

Next.js Documentation Updater

Name: Next.js Documentation Updater
Author: vercel

byvercel

•

137,365

•

Aprendizaje y Documentación

Synchronizes Next.js documentation with code changes through automated impact analysis and standardized MDX templates.

The Next.js Documentation Updater skill streamlines the maintenance of technical documentation by analyzing Git diffs to identify which documentation files are affected by recent code changes. It provides a guided workflow for maintainers and contributors, offering automated mapping between source files and doc paths, enforcing repository-specific formatting conventions, and providing structural templates for API references and guides. This tool ensures that documentation stays in sync with the codebase, improving accuracy for both App and Pages router content while maintaining high standards for MDX formatting and frontmatter.

Características Principales

01137,365 GitHub stars

02Automated impact mapping between source code and MDX files

03Standardized templates for API references and feature guides

04Context-aware guidance for App Router and Pages Router content

05Identification of shared content sources to prevent duplicate edits

06Frontmatter and MDX formatting validation via linting tools

Casos de Uso

01Scaffolding comprehensive guides for new framework features

02Reviewing Pull Requests for documentation completeness and accuracy

03Updating API reference tables after modifying component props

Características Principales

01137,365 GitHub stars

02Automated impact mapping between source code and MDX files

03Standardized templates for API references and feature guides

04Context-aware guidance for App Router and Pages Router content

05Identification of shared content sources to prevent duplicate edits

06Frontmatter and MDX formatting validation via linting tools

Casos de Uso

01Scaffolding comprehensive guides for new framework features

02Reviewing Pull Requests for documentation completeness and accuracy

03Updating API reference tables after modifying component props