nextjs · Next.js Docs
Next.js Docs Contribution Guide
Instructions for contributing to the Next.js documentation, including the GitHub workflow, writing MDX, configuring VSCode for local previews, and the review process.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Next.js Docs Contribution Guide
Instructions for contributing to the Next.js documentation, including the GitHub workflow, writing MDX, configuring VSCode for local previews, and the review process.
When To Use
Use when you need to set up a local development environment for editing Next.js documentation or need to follow the correct pull request workflow for community contributions.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/nextjs-docs-contribution-guide-workflow-guide.md | A markdown guide outlining the workflow, GitHub processes, and MDX writing standards for contributing to the Next.js documentation. | Questions about a markdown guide outlining the workflow, GitHub processes, and MDX writing standards for contributing to the Next.js... |
examples/nextjs-docs-contribution-guide-editorconfig-settings.json | A JSON configuration snippet defining file associations for MDX files within the Next.js documentation repository. | Exact payloads, commands, or snippets shown in A JSON configuration snippet defining file associations for MDX files within the Next.js documentation repository. |
examples/nextjs-docs-contribution-guide-directory-structure.txt | A text representation of the directory structure and file organization used within the Next.js documentation repository. | Exact payloads, commands, or snippets shown in A text representation of the directory structure and file organization used within the Next.js documentation repository. |
examples/nextjs-docs-contribution-guide-directory-structure-2.txt | A text representation of the directory structure and file organization required for contributing to the Next.js documentation repository. | Exact payloads, commands, or snippets shown in A text representation of the directory structure and file organization required for contributing to the Next.js docum... |
examples/nextjs-docs-contribution-guide-yaml-frontmatter.yaml | A YAML example demonstrating the frontmatter structure used for Next.js documentation pages. | Exact payloads, commands, or snippets shown in A YAML example demonstrating the frontmatter structure used for Next.js documentation pages. |
examples/nextjs-docs-contribution-guide-frontmatter.yaml | A YAML example demonstrating the frontmatter structure used for Next.js documentation pages including navtitle, source, and related fields. | Exact payloads, commands, or snippets shown in A YAML example demonstrating the frontmatter structure used for Next.js documentation pages including navtitle, sourc... |
examples/nextjs-docs-contribution-guide-mdx-template.mdx | An MDX file template demonstrating the frontmatter and structure required for contributing to the Next.js documentation. | Exact payloads, commands, or snippets shown in An MDX file template demonstrating the frontmatter and structure required for contributing to the Next.js documentation. |
examples/nextjs-docs-contribution-guide-mdx-template-2.mdx | An MDX file template demonstrating the frontmatter structure and content injection comments used for Next.js documentation pages. | Exact payloads, commands, or snippets shown in An MDX file template demonstrating the frontmatter structure and content injection comments used for Next.js document... |
examples/nextjs-docs-contribution-guide.mdx | The MDX source file containing the Next.js documentation contribution guidelines and content structure. | Exact payloads, commands, or snippets shown in The MDX source file containing the Next.js documentation contribution guidelines and content structure. |
examples/nextjs-docs-contribution-guide.tsx | A TypeScript React component demonstrating the structure and syntax used within the Next.js documentation contribution guide. | Exact payloads, commands, or snippets shown in A TypeScript React component demonstrating the structure and syntax used within the Next.js documentation contributio... |
examples/nextjs-docs-contribution-guide.jsx | A JSX code example demonstrating the formatting standards for JavaScript files without JSX within the Next.js documentation. | Exact payloads, commands, or snippets shown in A JSX code example demonstrating the formatting standards for JavaScript files without JSX within the Next.js documen... |
examples/nextjs-docs-contribution-guide-typescript-no-jsx.tsx | A TypeScript file demonstrating the implementation of documentation components without using JSX syntax. | Exact payloads, commands, or snippets shown in A TypeScript file demonstrating the implementation of documentation components without using JSX syntax. |
examples/nextjs-docs-contribution-guide-nextjs-docs-ts-js-switcher.jsx | A JSX code example demonstrating how to implement a language switcher component to toggle between TypeScript and JavaScript code blocks in Next.js documentation. | Exact payloads, commands, or snippets shown in A JSX code example demonstrating how to implement a language switcher component to toggle between TypeScript and Java... |
examples/nextjs-docs-contribution-guide.text | A text-based guide outlining the community contribution process and technical standards for the Next.js documentation. | Exact payloads, commands, or snippets shown in A text-based guide outlining the community contribution process and technical standards for the Next.js documentation. |
examples/nextjs-docs-contribution-guide-markdown-syntax-examples.text | A collection of markdown syntax examples demonstrating how to use multi-line code blocks and highlighting within the Next.js documentation. | Exact payloads, commands, or snippets shown in A collection of markdown syntax examples demonstrating how to use multi-line code blocks and highlighting within the... |
examples/nextjs-docs-contribution-guide-line-highlight-syntax.text | An example demonstrating the syntax for highlighting a specific range of lines within the Next.js documentation. | Exact payloads, commands, or snippets shown in An example demonstrating the syntax for highlighting a specific range of lines within the Next.js documentation. |
examples/nextjs-docs-contribution-guide-icons-list.text | A list of available icons used within the Next.js documentation. | Exact payloads, commands, or snippets shown in A list of available icons used within the Next.js documentation. |
examples/nextjs-docs-contribution-guide-style-rules.text | A text file outlining the stylistic guidelines and formatting rules for contributing to the Next.js documentation. | Exact payloads, commands, or snippets shown in A text file outlining the stylistic guidelines and formatting rules for contributing to the Next.js documentation. |
examples/nextjs-docs-contribution-guide-formatting-conventions.text | A text file outlining the specific formatting rules for notes and related links within the Next.js documentation. | Exact payloads, commands, or snippets shown in A text file outlining the specific formatting rules for notes and related links within the Next.js documentation. |
What This Skill Covers
- For an index of all Next.js documentation, see /docs/llms.txt. Welcome to the Next.js Docs Contribution Guide! We're excited to have you here.
- Main sections:
Why Contribute?,How to Contribute,GitHub Workflow,Writing MDX,VSCode.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://nextjs.org/docs/community/contribution-guide