Docs/project structure polish #84386
Conversation
…n, and not-found description; improve microcopy PR title docs: polish Project Structure page (grammar, consistency, clarity) PR description Fixes an Oxford comma in the routing files description for consistency. Normalizes heading capitalization to sentence case. Corrects “Files conventions” → “File conventions”. Aligns not-found.js description with earlier table (it’s not an error boundary). Clarifies intercepting routes microcopy.
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
| - `error.js` (React error boundary) | ||
| - `loading.js` (React suspense boundary) | ||
| - `not-found.js` (React error boundary) | ||
| - `not-found.js` (Not found UI) |
There was a problem hiding this comment.
It is an error boundary though, I see your point.
It is an error boundary that can catch a special error, https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/http-access-fallback/error-boundary.tsx,
Do you think there's a way in which we could communicate both ideas?
There was a problem hiding this comment.
Thanks for the clarification! I see your point that not-found.js is technically an error boundary for a specific type of error.
To communicate both ideas, would it be better to change the text to not-found.js (Error boundary for "not found" state)? This seems to be the most accurate description.
I'm happy to make this change and push a new commit once you confirm this wording.
There was a problem hiding this comment.
Yeah I think that'd work -
There was a problem hiding this comment.
Great, thank you! I've made the change and pushed a new commit.
| - `error.js` (React error boundary) | ||
| - `loading.js` (React suspense boundary) | ||
| - `not-found.js` (React error boundary) | ||
| - `not-found.js` (Error boundary for "not found" state) |
There was a problem hiding this comment.
| - `not-found.js` (Error boundary for "not found" state) | |
| - `not-found.js` (React error boundary for "not found" UI) |
There was a problem hiding this comment.
Thanks for the suggestion! I made this update and pushed a new commit.
PR title - docs: polish Project Structure page (grammar, consistency, clarity)
PR description -