Skip to content

Commit

Permalink
chore: Improve readme for devtools package (#7138)
Browse files Browse the repository at this point in the history
* chore: Improve readme for devtools package

* chore: remove internal link
  • Loading branch information
andyjessop authored Oct 31, 2024
1 parent 74ede56 commit 2e43346
Showing 1 changed file with 73 additions and 1 deletion.
74 changes: 73 additions & 1 deletion packages/wrangler-devtools/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,78 @@
# Wrangler Devtools Pages Project

This package contains a Workers specific version of Chrome Devtools that is used by the Wrangler dev command.
This package contains a Workers specific version of Chrome Devtools that is used by the Wrangler dev command. It is a customized fork of Chrome DevTools specifically tailored for debugging Cloudflare Workers. This package provides Worker-specific functionality through carefully maintained patches on top of Chrome DevTools.

## Overview

This package is used across multiple Cloudflare products:

- Workers Playground (`workers-playground`)
- Quick Editor (`@cloudflare/quick-edit`)
- Wrangler CLI via the `InspectorProxy`

## Features

Our customized DevTools implementation provides:

- Source code viewing and live updates
- Network request inspection
- Worker-specific UI optimizations

## Development

We maintain this fork by applying patches on top of Chrome DevTools. These patches need to be periodically rebased as Chrome DevTools evolves.

**Key Development Tasks:**

- Generating patches from our customizations
- Rebasing patches onto new Chrome DevTools versions
- Testing functionality across all integration points

## Updating DevTools

We perform quarterly updates to stay current with upstream Chrome DevTools. The update process involves:

1. Cloning the devtools-frontend repo
2. Applying our existing patches
3. Rebasing onto the latest Chrome DevTools
4. Regenerating patches
5. Thorough testing across all integration points

**For detailed instructions on updating DevTools, please refer to our internal documentation on keeping devtools up-to-date.**

## Testing

Two methods are available for testing updates:

**Local Development:**

- Build and serve DevTools locally
- Test against local Playground instance
- Make targeted fixes as needed

**Preview Builds:**

- Add `preview:wrangler-devtools` label to PRs
- Use deployed preview URL for testing
- Verify functionality in Playground

## Acceptance Criteria

Our DevTools implementation must maintain full functionality across:

- Console operations (logging, errors, filters)
- Source code viewing and debugging
- Network request inspection
- Worker-specific UI customizations

## Contributing

When making changes:

- Keep patches minimal and targeted
- Prefer CSS-based UI modifications
- Test thoroughly across all integration points
- Document any new patches or modifications

## Deployment

Expand Down

0 comments on commit 2e43346

Please sign in to comment.