Skip to content

Commit 78660a5

Browse files
Add gitignore note for next-env.d.ts (#86809)
<!-- 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 ### 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 ### What? Adds a note to the `next-env.d.ts` entry in the project structure documentation. ### Why? To clarify that `next-env.d.ts` is a generated file and should be excluded from version control (i.e., added to `.gitignore`). This helps developers follow best practices for Next.js project setup. ### How? Updated `docs/01-app/01-getting-started/02-project-structure.mdx` to add "(should not be tracked by version control)" to the description of `next-env.d.ts`. Closes NEXT- Fixes # --> --- [Slack Thread](https://vercel.slack.com/archives/C07BS1WEYAZ/p1764841040993409?thread_ts=1764841040.993409&cid=C07BS1WEYAZ) <a href="https://cursor.com/background-agent?bcId=bc-fc2eab83-628d-4ae1-b190-436d7e00063e"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-cursor-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg"></picture></a>&nbsp;<a href="https://cursor.com/agents?id=bc-fc2eab83-628d-4ae1-b190-436d7e00063e"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-web-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web" src="https://cursor.com/open-in-web.svg"></picture></a> --------- Co-authored-by: Cursor Agent <[email protected]>
1 parent 0e973f7 commit 78660a5

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/01-app/01-getting-started/02-project-structure.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,22 @@ Top-level folders are used to organize your application's code and static assets
3131

3232
Top-level files are used to configure your application, manage dependencies, run proxy, integrate monitoring tools, and define environment variables.
3333

34-
| | |
35-
| ---------------------------------------------------------------------------- | --------------------------------------- |
36-
| **Next.js** | |
37-
| [`next.config.js`](/docs/app/api-reference/config/next-config-js) | Configuration file for Next.js |
38-
| [`package.json`](/docs/app/getting-started/installation#manual-installation) | Project dependencies and scripts |
39-
| [`instrumentation.ts`](/docs/app/guides/instrumentation) | OpenTelemetry and Instrumentation file |
40-
| [`proxy.ts`](/docs/app/api-reference/file-conventions/proxy) | Next.js request proxy |
41-
| [`.env`](/docs/app/guides/environment-variables) | Environment variables |
42-
| [`.env.local`](/docs/app/guides/environment-variables) | Local environment variables |
43-
| [`.env.production`](/docs/app/guides/environment-variables) | Production environment variables |
44-
| [`.env.development`](/docs/app/guides/environment-variables) | Development environment variables |
45-
| [`eslint.config.mjs`](/docs/app/api-reference/config/eslint) | Configuration file for ESLint |
46-
| `.gitignore` | Git files and folders to ignore |
47-
| `next-env.d.ts` | TypeScript declaration file for Next.js |
48-
| `tsconfig.json` | Configuration file for TypeScript |
49-
| `jsconfig.json` | Configuration file for JavaScript |
34+
| | |
35+
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
36+
| **Next.js** | |
37+
| [`next.config.js`](/docs/app/api-reference/config/next-config-js) | Configuration file for Next.js |
38+
| [`package.json`](/docs/app/getting-started/installation#manual-installation) | Project dependencies and scripts |
39+
| [`instrumentation.ts`](/docs/app/guides/instrumentation) | OpenTelemetry and Instrumentation file |
40+
| [`proxy.ts`](/docs/app/api-reference/file-conventions/proxy) | Next.js request proxy |
41+
| [`.env`](/docs/app/guides/environment-variables) | Environment variables (should not be tracked by version control) |
42+
| [`.env.local`](/docs/app/guides/environment-variables) | Local environment variables (should not be tracked by version control) |
43+
| [`.env.production`](/docs/app/guides/environment-variables) | Production environment variables (should not be tracked by version control) |
44+
| [`.env.development`](/docs/app/guides/environment-variables) | Development environment variables (should not be tracked by version control) |
45+
| [`eslint.config.mjs`](/docs/app/api-reference/config/eslint) | Configuration file for ESLint |
46+
| `.gitignore` | Git files and folders to ignore |
47+
| `next-env.d.ts` | TypeScript declaration file for Next.js (should not be tracked by version control) |
48+
| `tsconfig.json` | Configuration file for TypeScript |
49+
| `jsconfig.json` | Configuration file for JavaScript |
5050

5151
<AppOnly>
5252

0 commit comments

Comments
 (0)