Files
react-native-devtools-frontend/docs
Philip Pfaffe f81e15369a Update workflow docs to remove the separate gclient projects workflow
With the reversed symlinks setup that workflow doesn\'t actually work anymore.

Bug: none
Change-Id: If1a3dc12b219fcf50bf378d5d84f31131d59ae02
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4839808
Auto-Submit: Philip Pfaffe <pfaffe@chromium.org>
Reviewed-by: Wolfgang Beyer <wolfi@chromium.org>
Commit-Queue: Philip Pfaffe <pfaffe@chromium.org>
Commit-Queue: Wolfgang Beyer <wolfi@chromium.org>
2023-09-05 11:02:43 +00:00
..
2021-04-08 12:25:52 +00:00

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

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.

  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.

Document Index

Design Documents

General Development

Testing

Architectural Documentation

Chromium