mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-05 11:31:31 +08:00
Benedikt Meurer
625c4bcd65
This CL adds an initial skeleton for the UX Style Guide and also merges the 1. go/chrome-devtools/ux-writing and 2. go/chrome-devtools/ui-glossary documentation sets into this already, as well as moving and slightly adjusting the Material 3 styling documentation. Bug: 354102605 Change-Id: Ida1e5e47038fac421e665eac9785bdc1fe04d6de Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5725533 Commit-Queue: Kim-Anh Tran <kimanh@chromium.org> Commit-Queue: Benedikt Meurer <bmeurer@chromium.org> Reviewed-by: Kim-Anh Tran <kimanh@chromium.org> Auto-Submit: Benedikt Meurer <bmeurer@chromium.org>
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
- UX Style Guide
- Contributing Changes
- Chrome DevTools Design Review Guidelines
- Release Management
- Dependencies
- Localization
- V8 debugger support checklist for new language features
- Chrome DevTools Protocol
- Visual logging in DevTools
- UMA metrics in DevTools
- How to add experiments in DevTools frontend
Testing
Architectural Documentation
Chromium
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 Markdown 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
- Upload a patch to gerrit, or receive a review request. e.g. https://chromium-review.googlesource.com/c/3362532
- View a specific .md file. e.g. https://chromium-review.googlesource.com/c/3362532/2/docs/README.md
- You will see something like
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.