Chromium DevTools docs

This directory contains Chrome DevTools project documentation in Gitiles-flavored Markdown. It is automatically rendered by Gitiles.

If you add new documents, please also add a link to them in the Document Index below.

[TOC]

Document Index

Design Documents

• See the shared Design Documents folder in the Chromium drive.

General Development

• Get the Code
• Contributing Changes
• Chrome DevTools Design Review Guidelines
• Release Management
• Dependencies
• Localization
• Material 3 in DevTools
• V8 debugger support checklist for new language features
• Chrome DevTools Protocol
• Visual logging in DevTools
• UMA metrics in DevTools
  • How to add UMA metrics in DevTools frontend
• How to add experiments in DevTools frontend

Testing

• Testing Chromium DevTools
• E2E test guide
• Unit test guide

Architectural Documentation

• Architecture of DevTools
• Resource management in DevTools

Chromium

• Chromium Docs
• V8 Documention

Useful Commands

git cl format --js

Formats all code using clang-format.

npm run check

Runs all static analysis checks on DevTools code.

Creating Documentation

Guidelines

• See the Chromium Documentation Guidelines and the Chromium Documentation Best Practices.
• Markdown documents must follow the style guide.

Previewing changes

Locally using md_browser

Assuming that /path/to/src contains a chromium checkout, you can run:

# in devtools-frontend checkout
/path/to/src/tools/md_browser/md_browser.py --directory $PWD

and preview the result by opening http://localhost:8080/docs/README.md in your browser. This is only an estimate. The gitiles view may differ.

Online with Gerrit's links to gitiles

1. Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/3362532
2. View a specific .md file. e.g. https://chromium-review.googlesource.com/c/3362532/2/docs/README.md
3. You will see something like
   Base preview -> Patchset 3 preview | DOWNLOAD
   at the top left of the page. Click on the second "preview" link to open the preview for the current patch set.

This gitiles view is the authoritative view, exactly the same as will be used when committed.