docs: add Wrangler autoconfig documentation by yomna-shousha · Pull Request #28221 · cloudflare/cloudflare-docs

yomna-shousha · 2026-02-09T17:41:53Z

Summary

This PR adds documentation for Wrangler's automatic project configuration feature, which allows users to deploy existing framework projects to Cloudflare Workers with a single command.

New pages

Deploy an existing project - Main reference page explaining automatic configuration, supported frameworks, and usage
Automatic pull requests - Explains the configuration PRs created by Workers Builds

Updated pages

Workers Builds index - Added "Automatic project configuration" section
Workers Builds configuration - Added "How Workers Builds works" section and moved autoconfig info
Wrangler commands - Added autoconfig explanation under deploy and setup, plus --yes flag documentation
13 framework guides - Added tip callouts linking to autoconfig page (Astro, Next.js, SvelteKit, Nuxt, React Router, Solid, Qwik, TanStack Start, Angular, Analog, Hono, Vike, Waku)

Changelog

No config? No problem. Just wrangler deploy - GA announcement for automatic configuration

Assets

Added screenshot of automatic configuration PR

TODO before merging

Update TODO_VERSION in src/content/docs/workers/framework-guides/autoconfig.mdx with the actual Wrangler version number
Update TODO_VERSION in src/content/changelog/workers/2026-02-10-wrangler-autoconfig-ga.mdx with the actual Wrangler version number

- Add new page: Deploy an existing project (autoconfig.mdx) - Add new page: Automatic pull requests (automatic-prs.mdx) - Update Workers Builds pages with autoconfig integration - Add tip callouts to 13 framework guides linking to autoconfig - Update wrangler commands page with autoconfig and --yes flag - Add automatic PR screenshot image

github-actions · 2026-02-09T17:42:53Z

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern	Owners
`/src/assets/images/workers/`	`@cloudflare/workers-docs`, `@GregBrimble`, `@irvinebroque`, `@WalshyDev`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`, `@cloudflare/wrangler`, `@mattietk`
`*.astro`	`@cloudflare/content-engineering`, `@kodster28`
`*.ts`	`@cloudflare/content-engineering`, `@kodster28`
`/src/content/docs/workers/ci-cd/`	`@irvinebroque`, `@aninibread`, `@GregBrimble`, `@cloudflare/pcx-technical-writing`, `@yomna-shousha`
`/src/content/docs/workers/`	`@cloudflare/workers-docs`, `@GregBrimble`, `@irvinebroque`, `@mikenomitch`, `@korinne`, `@WalshyDev`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`, `@cloudflare/wrangler`, `@mattietk`, `@cloudflare/dev-plat-leads`
`/src/content/docs/workers/wrangler/`	`@cloudflare/wrangler`, `@irvinebroque`, `@cloudflare/pcx-technical-writing`

elithrar · 2026-02-09T17:43:03Z

/bonk review this and ensure all code examples are valid

github-actions · 2026-02-09T17:56:54Z

Preview URL: https://791d51a5.preview.developers.cloudflare.com
Preview Branch URL: https://yomna-autoconfig-docs-updates.preview.developers.cloudflare.com

Files with changes (up to 15)

yomna-shousha · 2026-02-09T18:21:49Z

/bonk review this PR using the docs agent guidelines

ask-bonk · 2026-02-09T18:27:44Z

PR Review: Wrangler Autoconfig Documentation

Overall Assessment

This is a well-structured PR that adds documentation for a new feature across the right set of pages. The content is clear, the cross-linking is thorough, and the framework guide tips are consistently applied. Below are the findings organized by severity.

Blocking Issues

1. TODO_VERSION placeholders must be resolved before merge

The PR description already calls this out, but for completeness: two files contain TODO_VERSION that will render as literal text:

src/content/docs/workers/framework-guides/autoconfig.mdx:14 -- Minimum required Wrangler version: **TODO_VERSION**
src/content/changelog/workers/2026-02-10-wrangler-autoconfig-ga.mdx:9 -- Starting with Wrangler **TODO_VERSION**

Style Guide Violations (Should Fix)

2. Contractions -- the style guide says "do not use contractions"

Three instances found:

autoconfig.mdx:163 -- If you don't want automatic configuration to run -- change to If you do not want
automatic-prs.mdx:46 -- if they don't match the detected settings -- change to if they do not match
automatic-prs.mdx:56 -- doesn't match the connected Worker -- change to does not match

3. Unused imports in autoconfig.mdx:9

import { Details, Render } from "~/components";

Neither Details nor Render is used anywhere in the file. This import should be removed.

Suggestions (Non-blocking)

4. Tip placement consistency across framework guides

The tips are well-written and consistent in messaging. However, the placement varies slightly:

Astro, Hono: Tip is placed after the "Deploy to Workers" button badge, before the "What is X?" section
Next.js: After the "simple getting started guide" note, before "What is Next.js?"
SvelteKit, React Router, TanStack Start, Vike: After intro text, before the first section heading
Solid: After the beta :::note, before intro text
Nuxt, Qwik, Angular, Analog, Waku: At the very top, before the first section

This is reasonable given each page has different structure, but it is worth noting the inconsistency in case a reviewer prefers uniformity.

5. Astro/Next.js/SvelteKit tips include framework-specific adapter details, but most others do not

For example:

Astro: "Wrangler will automatically detect Astro, install the Cloudflare adapter, and configure your project"
Next.js: "Wrangler will automatically run @opennextjs/cloudflare migrate to configure your project"
SvelteKit: "Wrangler will automatically install the SvelteKit adapter and configure your project"
All others: "Wrangler will automatically configure your project"

This is actually a nice touch that adds specificity where relevant. No change needed, just calling it out as a deliberate pattern.

6. autoconfig.mdx -- the wrangler.jsonc code example uses compatibility_date: "2025-01-01"

This is fine as a representative example, but consider whether the date should be updated to something more current (e.g., 2025-09-01 or whatever the actual autoconfig default will be).

7. Changelog uses em dash (—) at line 17

You no longer need to pass the --x-autoconfig flag — this is now the default behavior.

This is stylistically acceptable in changelog entries (which are more blog-like), so not a strict issue.

What Looks Good

Frontmatter: All new pages have correct pcx_content_type values (concept for autoconfig and automatic-prs, changelog uses the standard structure). Descriptions are present and appropriately descriptive.
Internal links: All 30+ internal links across the new files resolve to existing pages (verified against the repo). No broken links detected.
Cross-referencing: The autoconfig page links to automatic-prs, the builds index links to both, the configuration page links to both, the Wrangler commands page links back -- the linking web is comprehensive.
Code examples: All code blocks have language specifiers (sh, jsonc, json, txt). No prompt prefixes ($) in shell commands. The jsonc, json, and txt blocks are correctly formatted.
Image reference: ~/assets/images/workers/ci-cd/builds/automatic-pr.png exists and is referenced correctly in both automatic-prs.mdx and the changelog.
Aside usage: :::note and :::tip are used correctly and sparingly. No overuse per section.
Sidebar ordering: autoconfig.mdx with sidebar.order: 1 will appear prominently in Framework guides. automatic-prs.mdx with sidebar.order: 3 fits logically in the builds section.

Summary

The PR is well-written and nearly ready to merge. The three items to address before merge:

Replace TODO_VERSION placeholders (already tracked in PR description)
Replace contractions with full forms (3 instances)
Remove unused Details and Render imports from autoconfig.mdx

github run

- Remove unused imports (Details, Render) from autoconfig.mdx - Fix contractions: don't → do not, doesn't → does not - Use WranglerConfig component with $today for compatibility_date - Replace em dash with period in changelog

…automatic-configuration.mdx

dario-piotrowicz · 2026-02-18T17:59:17Z

src/content/docs/workers/framework-guides/automatic-configuration.mdx

+```sh
+npx wrangler deploy
+```


We should ideally use the PackageManagers component instead of an sh block (so that it can show the various different package manager alternatives as well).

Like this for example:

cloudflare-docs/AGENTS.md

Line 198 in f48edca

<PackageManagers type="exec" pkg="wrangler" args="init my-project" />

This applies to all the similar blocks below

yomna-shousha · 2026-02-18T18:21:19Z

/bonk use the PackageManagers component instead of an sh block for all blocks in this pull request

ask-bonk · 2026-02-18T18:21:49Z

Resource not accessible by integration - https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment

github run

ask-bonk · 2026-02-18T18:21:51Z

Bonk workflow failed. Check the logs for details.

View workflow run

ask-bonk · 2026-02-18T18:26:06Z

Replaced all 4 sh code blocks in src/content/docs/workers/framework-guides/automatic-configuration.mdx with the PackageManagers component:

Before	After
```sh `npx wrangler deploy` ```	`<PackageManagers type="exec" pkg="wrangler" args="deploy" />`
```sh `npx wrangler setup` ```	`<PackageManagers type="exec" pkg="wrangler" args="setup" />`
```sh `npx wrangler setup --dry-run` ```	`<PackageManagers type="exec" pkg="wrangler" args="setup --dry-run" />`
```sh `npx wrangler deploy --yes` ```	`<PackageManagers type="exec" pkg="wrangler" args="deploy --yes" />`

Also added PackageManagers to the import statement. The PackageManagers component will render tabs showing the equivalent command for npm, yarn, and pnpm, matching the pattern used throughout the Workers documentation. No other files in this PR contained sh blocks that needed conversion.

github run

…re image - Replace inline `npx wrangler deploy` with PackageManagers component in 13 framework guide tip callouts - Restore automatic-pr.png image that was accidentally removed

…rkspaces - Clarify that multiple frameworks error only occurs in Workers Builds dashboard - Add links to root directory and monorepo setup documentation - Simplify workspaces section wording

- Add Next.js caching section explaining automatic R2 cache setup - Update frameworks table to reference R2 caching for Next.js - Update Next.js guide tip to mention automatic R2 caching

dario-piotrowicz · 2026-02-19T10:48:11Z

src/content/docs/workers/framework-guides/automatic-configuration.mdx

+| [Angular](/workers/framework-guides/web-apps/more-web-frameworks/angular/)   |                                |                                                     |
+| [Analog](/workers/framework-guides/web-apps/more-web-frameworks/analog/)     | Built-in Cloudflare preset     |                                                     |
+| [Vite](/workers/vite-plugin/)                                                | Cloudflare Vite plugin         |                                                     |
+| [Hono](/workers/framework-guides/web-apps/more-web-frameworks/hono/)         |                                |                                                     |


Hono is not supported 😓

dario-piotrowicz · 2026-02-19T11:00:12Z

src/content/docs/workers/framework-guides/web-apps/more-web-frameworks/hono.mdx

+
+<PackageManagers type="exec" pkg="wrangler" args="deploy" />
+
+Wrangler will automatically configure your project. Refer to [Deploy an existing project](/workers/framework-guides/automatic-configuration/) for details.


Hono is not supported by autoconfig 😓

dario-piotrowicz · 2026-02-19T11:09:25Z

src/content/docs/workers/framework-guides/automatic-configuration.mdx

+
+### Framework not detected
+
+If your framework is not detected, ensure your `package.json` includes the framework as a dependency. If the framework is not in the [supported list](#supported-frameworks), you'll need to manually configure your project.


Autoconfig can also work with frameworks that we don't officially support, for example SPAs such as react (vite-based), so possibly we should either clarify that in the supported list or be a bit more vague here.

Suggested change

If your framework is not detected, ensure your `package.json` includes the framework as a dependency. If the framework is not in the [supported list](#supported-frameworks), you'll need to manually configure your project.

If your framework is not detected, ensure your `package.json` includes the framework as a dependency. If the framework is not in the [supported list](#supported-frameworks), you might need to manually configure your project.

- Create AutoconfigDiagram.astro component with auto-play looping animation - Add diagram and 'Automatic configuration' callouts to all 12 framework pages - Export component from src/components/index.ts

yomna-shousha requested review from a team, GregBrimble, MattieTK, WalshyDev, aninibread, irvinebroque, korinne and mikenomitch as code owners February 9, 2026 17:41

github-actions bot added product:workers Related to Workers product size/m labels Feb 9, 2026

github-actions bot assigned GregBrimble, irvinebroque, MattieTK, WalshyDev, aninibread, korinne and mikenomitch Feb 9, 2026

yomna-shousha requested a review from dario-piotrowicz February 9, 2026 17:45

This comment was marked as outdated.

Sign in to view

docs: add changelog for autoconfig GA release

c173696

yomna-shousha requested a review from a team as a code owner February 9, 2026 18:08

docs: address style guide feedback from Bonk review

f2c207d

- Remove unused imports (Details, Render) from autoconfig.mdx - Fix contractions: don't → do not, doesn't → does not - Use WranglerConfig component with $today for compatibility_date - Replace em dash with period in changelog

yomna-shousha mentioned this pull request Feb 18, 2026

changelog: add Wrangler autoconfig GA announcement #28423

Open

1 task

yomna-shousha added 2 commits February 18, 2026 12:24

remove changelog (moved to separate PR) and rename autoconfig.mdx to …

93817e3

…automatic-configuration.mdx

remove changelog image (moved to separate PR)

bcd07a0

dario-piotrowicz reviewed Feb 18, 2026

View reviewed changes

Replace sh code blocks with PackageManagers component in autoconfig docs

2411dea

dario-piotrowicz and others added 4 commits February 18, 2026 18:29

clarify that the multiple frameworks error only happens in CI

d884fcc

add troublshooting section regarding workspaces

ce6a9d9

docs: use PackageManagers component in framework guide tips and resto…

0450cc1

…re image - Replace inline `npx wrangler deploy` with PackageManagers component in 13 framework guide tip callouts - Restore automatic-pr.png image that was accidentally removed

docs: clarify troubleshooting sections for multiple frameworks and wo…

9a8421b

…rkspaces - Clarify that multiple frameworks error only occurs in Workers Builds dashboard - Add links to root directory and monorepo setup documentation - Simplify workspaces section wording

dario-piotrowicz mentioned this pull request Feb 18, 2026

Add a warning in the autoconfig logic letting users know that support for projects inside workspaces is limited cloudflare/workers-sdk#12595

Merged

5 tasks

docs: add Next.js R2 caching information to autoconfig docs

cfd3db6

- Add Next.js caching section explaining automatic R2 cache setup - Update frameworks table to reference R2 caching for Next.js - Update Next.js guide tip to mention automatic R2 caching

dario-piotrowicz reviewed Feb 19, 2026

View reviewed changes

yomna-shousha added 4 commits February 19, 2026 07:18

Merge branch 'production' into yomna/autoconfig-docs-updates

956a254

Remove Hono from autoconfig - not supported

72568e9

Clarify autoconfig may work with other projects like React/Vue SPAs

a461238

Add AutoconfigDiagram component and update framework guide pages

f8dc3ac

- Create AutoconfigDiagram.astro component with auto-play looping animation - Add diagram and 'Automatic configuration' callouts to all 12 framework pages - Export component from src/components/index.ts

yomna-shousha closed this Feb 19, 2026

yomna-shousha reopened this Feb 19, 2026

yomna-shousha requested review from a team and kodster28 as code owners February 19, 2026 16:19

github-actions bot added the size/xl label Feb 19, 2026

github-actions bot assigned kodster28 Feb 19, 2026

Trigger preview rebuild

791d51a

dario-piotrowicz mentioned this pull request Feb 19, 2026

Autoconfig GA cloudflare/workers-sdk#12614

Open

5 tasks


		<PackageManagers type="exec" pkg="wrangler" args="deploy" />

		Wrangler will automatically configure your project. Refer to [Deploy an existing project](/workers/framework-guides/automatic-configuration/) for details.


		### Framework not detected

		If your framework is not detected, ensure your `package.json` includes the framework as a dependency. If the framework is not in the [supported list](#supported-frameworks), you'll need to manually configure your project.

Conversation

yomna-shousha commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New pages

Updated pages

Changelog

Assets

TODO before merging

Uh oh!

github-actions bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elithrar commented Feb 9, 2026

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

github-actions bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yomna-shousha commented Feb 9, 2026

Uh oh!

ask-bonk bot commented Feb 9, 2026

PR Review: Wrangler Autoconfig Documentation

Overall Assessment

Blocking Issues

Style Guide Violations (Should Fix)

Suggestions (Non-blocking)

What Looks Good

Summary

Uh oh!

dario-piotrowicz Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

yomna-shousha commented Feb 18, 2026

Uh oh!

ask-bonk bot commented Feb 18, 2026

Uh oh!

ask-bonk bot commented Feb 18, 2026

Uh oh!

ask-bonk bot commented Feb 18, 2026

Uh oh!

dario-piotrowicz Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

dario-piotrowicz Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

dario-piotrowicz Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

Comments

yomna-shousha commented Feb 9, 2026 •

edited

Loading

github-actions bot commented Feb 9, 2026 •

edited

Loading

github-actions bot commented Feb 9, 2026 •

edited

Loading