mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-30 01:43:36 +08:00
Benedikt Meurer
cde66e4b13
Bug: 1358806 Change-Id: I159055b6542d7cac718edb7fb89ed0cdb7826b77 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/3864092 Commit-Queue: Victor Porof <victorporof@chromium.org> Auto-Submit: Benedikt Meurer <bmeurer@chromium.org> Reviewed-by: Victor Porof <victorporof@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.