2aefd05123
docs: fix typos in contribution guide ( #94375 )
...
Fixed `search from` → `search for` and `at the of the page` → `at the
top of the page` (confirmed by checking API ref pages — overview tables
go at the top after a short intro and example).
2026-06-05 00:03:33 +02:00
0b8a0fb429
docs: escape literal triple-backticks in contribution guide ( #93584 )
...
Updates:
https://nextjs.org/docs/community/contribution-guide#language-and-filename
to:
<img width="1335" height="690" alt="Screenshot 2026-05-07 at 14 26 35"
src="https://github.com/user-attachments/assets/588799a3-1a0e-4696-9600-627df270f48e "
/>
2026-05-07 14:46:44 +02:00
34b5db7e83
Next CLI flags documentation ( #89750 )
...
Co-authored-by: Cursor Agent <cursoragent@cursor.com >
Co-authored-by: Joseph Chamochumbi <joseph.chamochumbi@vercel.com >
2026-02-11 20:15:04 +01:00
19421c3792
docs: fix broken examples link ( #86916 )
...
### What?
Fix broken link in the documentation pointing to the examples folder.
### Why?
The previous link to the examples folder in
`docs/04-community/index.mdx` was incorrect:
https://github.com/vercel/next.js/tree/canary/contributing/examples
This caused confusion and 404 errors for contributors trying to access
the correct examples.
(the url page is in here
https://nextjs.org/docs/community/contribution-guide )
### How?
Updated the link in `docs/04-community/index.mdx` to point to the
correct folder:
from
https://github.com/vercel/next.js/tree/canary/contributing/examples
to
https://github.com/vercel/next.js/tree/canary/examples
Co-authored-by: Joseph <joseph.chamochumbi@vercel.com >
2025-12-08 22:12:13 +01:00
2307d46f51
docs: update prefix two-digit number in routing section ( #77758 )
...
## Description
The current [routing
documents](https://github.com/vercel/next.js/tree/canary/docs/01-app/03-building-your-application/01-routing )
are missing `01` and `02` prefix.
This PR changes the numbering of them and update [contribution-guide
docs](https://github.com/vercel/next.js/blob/canary/docs/04-community/01-contribution-guide.mdx ).
### Improving Documentation
- [x] Run `pnpm prettier-fix` to fix formatting issues before opening
the PR.
- [x] Read the Docs Contribution Guide to ensure your contribution
follows the docs guidelines:
https://nextjs.org/docs/community/contribution-guide
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
## For Contributors
Co-authored-by: Joseph <joseph.chamochumbi@vercel.com >
2025-12-01 11:46:38 +01:00
3b94ab2dd9
docs:Small improvement on the contribution guide for clarity ( #84200 )
...
### What?
Improves the contribution guide (`01-contribution-guide.mdx`) by fixing
a typo and clarifying wording for JavaScript files with JSX code.
### Why?
This is my first time ontributing to open source, i've taken my time to
read the contribution guide and noticed this small inconsisntency. My
motivation was to start small by fixing this issue and make a
contribution, with the intention of following up with greater
improvements later. This change also helps make the documentation
clearer for new contributors and keeps it aligned with the Next.js style
guide.
### How?
**Before:**
> - Make sure to use `js` extension with JSX code at JavaScript files.
**After:**
> - Make sure to use `.js` extension for JavaScript files with **JSX**
code.
Co-authored-by: Joseph <joseph.chamochumbi@vercel.com >
2025-09-26 17:47:47 +02:00
2e2ee08b60
Docs IA 2.0: Delete routing section, add BFF guide, polish getting started ( #80365 )
...
Closes:
https://linear.app/vercel/issue/DOC-4686/clean-up-routing-section
Redirects: https://github.com/vercel/front/pull/47151
---------
Co-authored-by: Joseph <joseph.chamochumbi@vercel.com >
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
2025-06-16 13:42:20 +01:00
0272c7f763
Docs: Add rspack community collab ( #80217 )
...
Closes:
https://linear.app/vercel/issue/DOC-4747/a-simple-rspack-reference
---------
Co-authored-by: Rich Haines <hello@richardhaines.dev >
2025-06-09 08:42:25 +00:00
75658b8115
docs: Delete empty optimizing folder ( #78966 )
...
Cleaning up 🧹
2025-05-08 10:18:31 -05:00
3aa8bc5f68
docs: add note to language and filename section ( #74239 )
...
## Description
Some people are baffled by [JavaScript files with JSX
code](https://nextjs.org/docs/community/contribution-guide#language-and-filename )
in [contribution
guide](https://nextjs.org/docs/community/contribution-guide ) due to
mismatch the extension.
Therefore, add the note like the below attention.
> [!NOTE]
> - Make sure to use **`js`** extension with **JSX** code at JavaScript
files.
> - For example, ```jsx filename="app/layout.js"
### Improving Documentation
- [x] Run `pnpm prettier-fix` to fix formatting issues before opening
the PR.
- [x] Read the Docs Contribution Guide to ensure your contribution
follows the docs guidelines:
https://nextjs.org/docs/community/contribution-guide
Closes #74175
Co-authored-by: Sam Ko <sam@vercel.com >
2025-02-24 19:46:37 +00:00
2de02bf269
docs: update file structure on contribution guide ( #73778 )
...
Co-authored-by: Lee Robinson <me@leerob.io >
2024-12-15 14:46:07 -06:00
34c91227b3
docs: update file structure ( #72748 )
...
## Summary
Sync
[`04-functions`](https://github.com/vercel/next.js/tree/canary/docs/01-app/03-api-reference/04-functions )
file convention.
### Improving Documentation
- [x] Run `pnpm prettier-fix` to fix formatting issues before opening
the PR.
- [x] Read the Docs Contribution Guide to ensure your contribution
follows the docs guidelines:
https://nextjs.org/docs/community/contribution-guide
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
## For Contributors
### Adding or Updating Examples
- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md
### Fixing a bug
- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md
### Adding a feature
- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas )
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs )
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md
## For Maintainers
- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change
### What?
### Why?
### How?
Closes NEXT-
Fixes #
-->
Co-authored-by: Sam Ko <sam@vercel.com >
2024-11-13 19:42:23 +00:00
fa8d558154
Docs: Split Getting Started between App and Pages, improve Installation page ( #72178 )
...
Prepare **Getting Started** Section for upcoming changes, and work on
the first page: `Installation`.
Closes:
-
https://linear.app/vercel/issue/DOC-3703/update-how-getting-started-is-handled-in-next-site
-
https://linear.app/vercel/issue/DOC-3694/page-how-to-set-up-a-new-nextjs-project-installation
- https://linear.app/vercel/issue/DOC-3707/create-subsection-for-plugins
- https://linear.app/vercel/issue/DOC-3709/eslint-plugin-api-reference
- https://linear.app/vercel/issue/DOC-3710/typescript-reference-page
### Key Changes:
- Duplicate Getting Started Section between App and Pages Router docs
- Since getting started will vary between the routers, each docs needs
to have their own Getting Started section
- Reorganize folder numbers
**Installation Page**:
- Split app and pages router specific information
- Rename "Installation" to "How to set up a Next.js application" for SEO
- Add setup instructions for **TypeScript**
- Add setup instructions for **ESLint**
- Add setup instructions for **Absolute Imports and Module Path
Aliases**
**Side effects from moving content around**:
- Create a subsection in API Reference called **Configuration**.
- Add ESLint Plugin page, and update it to follow template
- Add TypeScript page, and update it to follow template
- Remove the **Absolute Imports and Module Path Aliases** page, it's
small enough to live under the set up instructions.
---------
Co-authored-by: Rich Haines <hello@richardhaines.dev >
2024-11-06 12:32:05 +00:00
Razin Shafayet