update-docs

Synchronize Next.js documentation with code changes on the active branch.

142k|31.7k|Updated Oct 5, 2016
One-click install
npx skills add https://github.com/vercel/next.js --skill update-docs-vercel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/vercel/next.js/tree/main/.agents/skills/update-docs
Command: npx skills add https://github.com/vercel/next.js --skill update-docs-vercel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps Next.js documentation in sync with code changes by guiding a structured workflow on the active branch.

Core Features & Use Cases

  • Analyze changes on the active branch and identify affected documentation.
  • Map changed source files to corresponding documentation references and propose updates.
  • Validate documentation completeness and consistency before merging.

Quick Start

Execute a PR-focused workflow by diffing the active branch against the canary branch and mapping code changes to docs references to prepare updates.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep Next.js documentation in sync with code changes during a PR review?

To keep Next.js documentation in sync with code changes during a PR review, this Skill diffs the active branch against the canary branch, maps changed source files to documentation references, and proposes structured updates to ensure completeness before merging.

What is the best way to map code paths to documentation references for feature updates?

Mapping code paths to documentation references requires a mapping reference file. This Skill uses that reference alongside code diffs to identify affected Next.js docs and automatically scaffold or update documentation for new features across packages.

Do I need a mapping reference to update docs from code diffs?

Yes, a mapping reference from code paths to docs is required. The documentation update workflow relies on this reference to connect source file changes on the active branch to the corresponding Next.js documentation files for accurate updates.

How does automated documentation completeness validation work for Next.js packages?

Documentation completeness validation works by linting and checking the updated docs against the code changes. It ensures consistent coverage across Next.js packages by verifying that all modified source files have corresponding updated documentation before merging.

Can I scaffold new documentation for features directly from an active branch diff?

Yes, you can scaffold new docs directly from an active branch diff. By analyzing the code changes against the canary branch, the Skill identifies unmapped new features and scaffolds the corresponding Next.js documentation structure automatically.