mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-06 12:01:40 +08:00
Charlie Harrison
822c80abac
Bug: none Change-Id: Ib6a1498df2f4c807bbe8b2d8a280f1abf994df84 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/3909123 Commit-Queue: Charlie Harrison <csharrison@chromium.org> Reviewed-by: Alex Rudenko <alexrudenko@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