mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-03 18:41:15 +08:00
Philip Pfaffe
5626e10094
R=jarin@chromium.org Bug: none Change-Id: Ie31d3828f448178df3d6b5e7b4480e9a6383e33e Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4112009 Commit-Queue: Philip Pfaffe <pfaffe@chromium.org> Reviewed-by: Jaroslav Sevcik <jarin@chromium.org> Auto-Submit: Philip Pfaffe <pfaffe@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]
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/docs
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
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.
Document Index
Design Documents
- See the shared Design Documents folder in the Chromium drive.
General Development
- Workflows
- Chrome DevTools Design Review Guidelines
- Release Management
- Third-party Guidelines
- Localization
- V8 debugger support checklist for new language features