mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-28 00:45:04 +08:00
Benedikt Meurer
69fc30e8b3
Going forward we want to have DevTools project documentation maintained within the source repository, following the model that Chromium uses for its project documentation[1]. This change sets up the basics for that, putting in place the main entry point (in docs/README.md) and moving the architecture documentation to the docs folders, as well as putting back the 3rd party guidelines here. We also adopt the simpler structure for images, making it easier to identify which document a given image file belongs to. [1]: https://chromium.googlesource.com/chromium/src/+/main/docs/README.md DISABLE_THIRD_PARTY_CHECK=reorganizing files Fixed: chromium:1358806 Change-Id: I70f7f90b95c7311ca24bede04ca9cdd5e4c31eaf Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/3865393 Commit-Queue: Kim-Anh Tran <kimanh@chromium.org> Reviewed-by: Yang Guo <yangguo@chromium.org> Reviewed-by: Kim-Anh Tran <kimanh@chromium.org> Auto-Submit: Benedikt Meurer <bmeurer@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.