Files
react-native-devtools-frontend/docs
Benedikt Meurer a75db5f8bc [docs] Improve documentation of metrics.
This cleans up the documentation for adding new metrics and adds
a page that gives an overview of the important existing metrics.

Bug: chromium:1447968
Change-Id: I26d8ab80f7861c505809a218b952d9864d0fbbfc
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4568189
Reviewed-by: Ergün Erdoğmuş <ergunsh@chromium.org>
Auto-Submit: Benedikt Meurer <bmeurer@chromium.org>
Commit-Queue: Benedikt Meurer <bmeurer@chromium.org>
2023-05-26 09:43:39 +00:00
..
2021-04-08 12:25:52 +00:00
2023-05-16 13:53:27 +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