Commit Graph

8 Commits

Author SHA1 Message Date
Tobias Koppers 3d57c6e581 docs: fix typos and correctness issues in App Router docs (#97823)
## Summary

A systematic review pass over the App Router documentation
(`docs/01-app`, 281 MDX files) fixing clear-cut typos, grammar issues,
and technical inaccuracies — code samples, file names, and API
signatures that had drifted from the implementation in
`packages/next/src`.

The review ran four passes: an automated spell check with a triaged
allowlist, targeted grammar-pattern searches, structural checks
(frontmatter, code fences, link targets), and a technical-accuracy pass
over all getting-started pages plus high-traffic API reference pages,
with every suspected inaccuracy verified against the source before
editing. Only unambiguous issues were fixed; anything debatable was
deliberately left alone (e.g. the `/aboot` route in the typedRoutes docs
is an *intentional* invalid-route example, and the CLI docs table
intentionally mirrors the actual `--help` output).

Notable fixes:

- JSX examples now `await params`, matching the Promise-based API and
their TypeScript counterparts
- `generateStaticParams()` is now exported in samples so the convention
actually takes effect
- `<Link prefetch>` props table includes `"auto"`, matching the `boolean
| "auto" | null` type in `link.tsx`
- `Navigator.geolocation` casing, the canonical react.dev `"use client"`
link, and a missing `Link` import in the typedRoutes docs
- Mismatched or wrong `filename=` labels in TS/JS switcher pairs
(`form.mdx`, `mutating-data.mdx`, `css.mdx`) and a wrong
`generateStaticParams` anchor target
- ESLint monorepo example registers the plugin as `@next/next` so the
documented rule prefixes resolve
- Spelling/grammar: `emphaize`, `invokations`, `behaviour` → American
spelling, "setup" → "set up" as a verb (5×), "a RSC" → "an RSC",
`NextJS` → `Next.js`, a stray comma, and "a `opengraph-image.tsx`"
article plus its folder path

## Verification

- `cspell` over all 281 files in `docs/01-app`: 0 issues outside a
reviewed allowlist of product names, API identifiers, and intentional
example strings
- `prettier --check` (3.6.2, repo config): passes on all 19 changed
files
- Grammar-pattern and structure greps: clean
- Technical claims cross-checked against `packages/next/src` and
`packages/eslint-plugin-next`
- Docs-only change; no runtime code touched

<!-- NEXT_JS_LLM -->


<!-- fleet eeae4385-18f5-406d-915e-986961503ed2 -->

Co-authored-by: vercel-fleet-prod[bot] <318278635+vercel-fleet-prod[bot]@users.noreply.github.com>
Co-authored-by: Tobias Koppers <1365881+sokra@users.noreply.github.com>
2026-08-25 12:12:37 +02:00
Jahanzaib iqbal c5a826f59d docs: fix broken Node.js inspector URL in debugging guide (#94934)
## What

Updates one broken URL in the debugging guide that returns 404.

```diff
-For help, see: https://nodejs.org/en/docs/inspector
+For help, see: https://nodejs.org/api/inspector.html
```

The old path (`/en/docs/inspector`) no longer exists after Node.js
restructured their documentation site. The replacement points to the
current Node.js Inspector API docs which returns 200.

## Why

This URL appears inside a terminal output code block showing what the
Node.js debugger prints when launched with `--inspect`. A reader who
follows the link to learn more about the inspector gets a 404.

A related fix for the separate Debugging Guide link
(`/en/docs/guides/debugging-getting-started`) is tracked in #93958. This
PR addresses the second broken Node.js URL in the same file that #93958
did not cover.

## Checklist

- [x] Docs-only change. No behavior impact.
- [x] Replacement URL verified to return HTTP 200.

<!-- NEXT_JS_LLM_PR -->
2026-06-18 12:41:20 +02:00
Giles Thompson 01a2363cef docs: Fix broken link to Node.js Debugging Guide (#93958)
[Live page](https://nextjs.org/docs/app/guides/debugging) links to:
https://nodejs.org/en/docs/guides/debugging-getting-started

Which is 404 now

Seems like this is where it should point now:
https://nodejs.org/learn/getting-started/debugging
2026-06-18 10:01:59 +00:00
Sebastian "Sebbie" Silbermann 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
Sebastian "Sebbie" Silbermann d56ed7bbca Allow inspecting server with next start --inspect (#88744) 2026-01-19 17:13:29 +01:00
Sebastian "Sebbie" Silbermann 1e53071f77 Allow inspecting dev server on default port with next dev --inspect (#85037)
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
2025-10-29 17:19:19 +01:00
PuppyOne 6e20a10d76 docs: add React Developer Tools section for debugging (#82320)
## What?

Added a new "React Developer Tools" section to the debugging
documentation.

## Why?

This PR resolves #82308 which highlighted that React DevTools - a
fundamental debugging tool for React applications - was missing from
Next.js debugging documentation.

Since the Next.js framework is built on React, React DevTools is crucial
for:
- Inspecting component hierarchies
- Debugging state and props
- Identifying performance issues
- Understanding application structure

## How?

Inserted a concise section between "Client-side code" and "Server-side
code" in
[docs/01-app/02-guides/debugging.mdx](https://github.com/vercel/next.js/blob/canary/docs/01-app/02-guides/debugging.mdx):

- Introduces developers to the essential React debugging tool and its
key features
- Direct users to the corresponding React documentation

### Checklist: Improving Documentation

- [x] Ran `pnpm prettier-fix` to ensure proper formatting
- [x] Followed the Docs Contribution Guide:
https://nextjs.org/docs/community/contribution-guide


Closes #82308

Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
2025-08-04 16:19:17 +02:00
Delba de Oliveira 7a64ada1ab docs: Move pages from Config section into guides (#78496) 2025-04-24 07:28:50 -05:00