update-docs

The `update-docs` skill is designed to streamline the process of keeping Next.js documentation in sync with ongoing code changes. It addresses the common challenge of ensuring that documentation accurately reflects the current state of a codebase, particularly when reviewing pull requests or adding new features. By providing a structured workflow, this skill reduces the likelihood of outdated or incomplete documentation, helping maintainers and contributors maintain high-quality reference material.

The skill offers a guided workflow with multiple stages: analyzing code changes, mapping them to affected documentation files, updating or scaffolding documentation, and validating changes. Key capabilities include identifying documentation-relevant changes in source files, mapping these changes to the appropriate `.mdx` documentation files, reviewing existing content for necessary updates, and applying edits with user confirmation. It also supports scaffolding entirely new feature documentation by determining the type of feature and suggesting the appropriate template and location in the documentation hierarchy. Additional validation steps, such as running linting and formatting checks, ensure that all updates adhere to project standards.

Target users include Next.js maintainers, documentation reviewers, and developers contributing new features or modifications that impact documentation. Use cases range from reviewing documentation for completeness during pull requests, updating API references for components or server functions, adding deprecation notices or new examples, to scaffolding documentation for new components or features. By following a structured workflow, the skill helps teams maintain accurate, consistent, and high-quality documentation across the Next.js project.