Commit Graph

11 Commits

Author SHA1 Message Date
Niklas Mischkulnig 10e0828fb9 Use JSONC for default server-external-packages (#86252)
So that we can then use comments to track a reason why we have added packages to this list.
2025-11-21 11:45:39 +01:00
Delba de Oliveira 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
JJ Kasper 166251dac4 Fix externals doc validation (#78208)
This moves the `validate-externals-doc` job to the `lint` step so it's
not skipped for docs only changes.

x-ref:
https://github.com/vercel/next.js/actions/runs/14475138181/job/40601279813
2025-04-15 11:29:39 -07:00
Delba de Oliveira 6bc472a788 Docs IA 2.0: Add Deep Dive section placeholder (#77724)
This section will be for developers who want to understand how things
work. It's not essential knowledge, but good to know.

A place for conceptual information and colorful diagrams that explain
the magic behind things ✨ 🌈
2025-04-04 16:24:56 +01:00
Delba de Oliveira 67921c23ef Docs: Create Examples section (#73858)
Closes: https://linear.app/vercel/issue/DOC-4047/create-examples-section

Redirects: https://github.com/vercel/front/pull/39878
2024-12-13 12:08:44 +00:00
Delba de Oliveira 0b35ddd825 Docs: Move next.config.js API pages under a config folder, fix headings in TS and ESLint config pages (#72465)
This PR:

- Moves `next.config.js` options under a "config" folder which includes
references for other configuration such as the ESLint plugin. I figure
it would be tidier than having "Next.config.js Options" and "Config" in
the API reference.
- Fixes the issue with the "config" folder not showing up in canary:
https://linear.app/vercel/issue/DOC-3749/bug-figure-out-why-new-config-folder-isnt-showing-up-in-the-canary
- Fixes the indentation issues and missing example header (caused by an
invisible character).

Redirects: https://github.com/vercel/front/pull/38704
2024-11-08 14:48:55 +00:00
Delba de Oliveira 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
Jiwon Choi b159d60fd6 HOTFIX: pages doc next-config-js was moved from 03 to 04 (#68370)
### Why?

`types-and-precompiled` is failing on CI: 

https://github.com/vercel/next.js/actions/runs/10186089792/job/28178038314

### How?

The script `validate-externals-doc.js` was validating the
`docs/.../03-next-config-js/...mdx` page, but the page was moved to
`docs/.../04-next-config-js/...mdx` in
https://github.com/vercel/next.js/pull/67839
2024-07-31 21:36:52 +02:00
JJ Kasper 11c19cfbf6 Fix validate externals docs 2024-05-23 06:56:52 -07:00
Ethan Arrowood d0d22ac625 Promote and rename server bundling options serverComponentsExternalPackages and bundlePagesExternals (#65421)
This PR promotes and renames experimental configuration options related
to server bundling:
- `serverComponentsExternalPackages` -> `serverExternalPackages`
- `bundlePagesExternals` -> `bundlePagesRouterDependencies`

Existing docs for `serverComponentsExternalPackages` was changed. 
New docs for `bundlePagesRouterDependencies` were added.

Closes NEXT-3332
2024-05-07 11:19:35 -06:00
JJ Kasper 80fa841c7c Add CI check to validate externals doc (#62968)
This avoids the need to manually check when these get out of sync by
having an automated check to keep them in sync when one or the other is
updated.

x-ref: https://github.com/vercel/next.js/pull/62966

Closes NEXT-2734
2024-03-06 17:00:25 -08:00