chore: Improve readme for devtools package

[andyjessop]

Fixes #000.

Improves the documentation surrounding our usage and maintenance of the Chrome DevTools patches.

---

• Tests
  • TODO (before merge)
  • Tests included
  • Tests not necessary because: Readme changes
• E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
  • I don't know
  • Required
  • Not required because: Readme changes
• Public documentation
  • TODO (before merge)
  • Cloudflare docs PR(s):
  • Documentation not necessary because: Internal readme only

[changeset-bot]

⚠️ No Changeset found

Latest commit: f66e40e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-wrangler-7138

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/7138/npm-package-wrangler-7138

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-wrangler-7138 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-create-cloudflare-7138 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-kv-asset-handler-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-miniflare-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-pages-shared-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-vitest-pool-workers-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-workers-editor-shared-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-workers-shared-7138

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/11610637579/npm-package-cloudflare-workflows-shared-7138

Note that these links will no longer work once the GitHub Actions artifact expires.

---

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
miniflare	workspace:*	3.20241022.0
workerd	1.20241022.0	1.20241022.0
workerd --version	1.20241022.0	2024-10-22

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

[emily-shen]

🎉

[edmundhung]

Love it! Thanks for preparing all the docs 👍🏼

[edmundhung]

I am not sure if we should link the internal wiki here. Do we have other examples doing this? How about moving the instructions here and put a github link in the wiki?

[andyjessop]

Oh yeah, you're absolutely right. Not sure why I put this here. I'll just say to refer to the internal documentation.

[emily-shen]

there's definitely a couple floating around if you search wiki.cfdata, should we clean up those...?

[andyjessop]

Yeap, I think it makes sense to get rid of those.