Skip to content

docs: local development: Rewrite docker section, add Windows Dev Drive and WSL2 instructions - #98164

Merged
bgw merged 2 commits into
canaryfrom
bgw/next-js-windows-dev-drive-and-docker-docs
Sep 2, 2026
Merged

docs: local development: Rewrite docker section, add Windows Dev Drive and WSL2 instructions#98164
bgw merged 2 commits into
canaryfrom
bgw/next-js-windows-dev-drive-and-docker-docs

Conversation

@bgw

@bgw bgw commented Sep 2, 2026

Copy link
Copy Markdown
Member

Follow-up to https://vercel.slack.com/archives/C046HAU4H7F/p1787344658655399

Summary:

  • Move system configuration changes into it's own section, separate from application and project configuration changes.
  • The Docker section was very light on details and didn't do a good job of explaining why this problem happens.
  • Also suggest https://docs.docker.com/desktop/features/synchronized-file-sharing/ for Docker and explicitly discourage watchOptions.pollIntervalMs as a workaround.
  • Suggest Windows Dev Drive (https://learn.microsoft.com/en-us/windows/dev-drive/). I don't have experience with it, but Microsoft recommends it and claims it improves filesystem performance.
  • Recommend trying WSL 2.

@bgw
bgw requested review from icyJoseph and timneutkens September 2, 2026 00:40
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Tests Passed

Commit: 3272f40


## Improving application development performance

### 1. Update Next.js and use Turbopack

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are the numbers important ? can we get auto numbering working/

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just sorta an order of priority? IDK, I was mostly preserving it from the other section.

This isn't an actual <ol> element, so markdown's auto-numbering doesn't apply here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe there is an mdx'ism for this? no big deal ofc

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I don't think there is.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dev drive is a better solution here, so mention... link below?

- Reserve Docker for production deployments and testing production builds.
- If you must use Docker for development, consider running Docker natively on a Linux machine or a manually configured virtual machine. If using a manually configured virtual machine, move the source code into the VM and do not share it from the host.
- If you're using Docker Desktop, evaluate using [synchronized file shares](https://docs.docker.com/desktop/features/synchronized-file-sharing/). Synchronized file shares still add latency compared to running Next.js directly on the host, but can improve file-watching reliability without resorting to polling.
- Avoid using `watchOptions.pollIntervalMs` in `next.config.js` to work around Fast Refresh issues. Only use it as a last resort. Polling adds significant latency and can drastically increase CPU and I/O usage.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this PR be merged, https://github.com/vercel/next.js/pull/80687/changes and x-references here? I understand we kind of want to discourage usage though — not all of the config options need a reference, specially if its there to serve what feels like an edge case in dev environments

@bgw bgw Sep 2, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can have the documentation if we are very clear on that documentation page why people should never use it. We've fixed most of the compatibility issues with Turbopack for that feature.

The only outstanding issue I know of is caused by notify-rs/notify#981, but we're waiting on a new release of notify-rs.

@bgw
bgw merged commit 5cca033 into canary Sep 2, 2026
66 checks passed
@bgw
bgw deleted the bgw/next-js-windows-dev-drive-and-docker-docs branch September 2, 2026 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants