Does it support both App Router and Pages Router documentation?

Yes, it is designed to handle Next.js dual-router architecture, recognizing and components to ensure content is placed correctly.

Can I use this to create entirely new documentation pages?

Absolutely. The skill includes specific workflows for scaffolding new components, functions, or guides using standardized templates.

Does the skill automatically modify my files without permission?

No, the workflow is designed to show you planned changes and wait for user confirmation before applying any edits to your MDX files.

How does it identify which documentation files need updating?

The skill performs a git diff analysis on your current branch and uses a mapping file (CODE-TO-DOCS-MAPPING.md) to link source code changes to their corresponding MDX paths.

How does it handle documentation formatting?

It follows predefined conventions for frontmatter and code blocks, and it can trigger 'pnpm lint' or 'prettier-fix' to ensure everything meets project standards.

Next.js Documentation Sync

Name: Next.js Documentation Sync
Author: blooma-club

byblooma-club

0•

学習とドキュメンテーション

Synchronizes Next.js MDX documentation with recent code changes through automated impact analysis and guided updates.

The update-docs skill streamlines the documentation lifecycle for Next.js projects by analyzing git diffs to identify impacted features and mapping them to specific MDX files. It guides developers through updating API references, props tables, and guides while enforcing consistent formatting, router-specific content rules, and frontmatter requirements. By automating the scaffolding of new feature documentation and providing a validation checklist, it ensures that technical documentation remains accurate, comprehensive, and perfectly in sync with the codebase.

主な機能

010 GitHub stars

02Guided MDX updates with support for App and Pages Router components

03Intelligent mapping of source files to documentation paths

04Integrated validation for frontmatter, code blocks, and linting

05Pre-built templates for API references, guides, and file conventions

06Automated code-to-docs impact analysis using git diff patterns

ユースケース

01Reviewing Pull Requests for documentation completeness and accuracy

02Scaffolding standardized API reference pages for new Next.js components

03Syncing documentation immediately after a feature implementation or bug fix

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add blooma-club/blooma update-docs

For use in Claude.ai and ChatGPT

Download Skill