mirror of https://github.com/react/react-native-devtools-frontend.git synced 2026-10-17 12:05:31 +08:00

Files

T

Mathias Bynens d3a5ea3ce3 [docs] Recommend --disable-infobars for local testing

For local testing, any automation infobars as well as the Chrome for
Testing-specific infobar aren’t usually desired.

Now that CfT reintroduced the `--disable-infobars` CLI flag, we can
recommend its use for this purpose.

Bug: chromium:1476789
Change-Id: Ic174f62d9df3846e891f3a420e0ecca75295bad2
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5077246
Commit-Queue: Benedikt Meurer <bmeurer@chromium.org>
Auto-Submit: Mathias Bynens <mathias@chromium.org>
Reviewed-by: Benedikt Meurer <bmeurer@chromium.org>

2023-11-30 14:00:41 +00:00

add_experiments.md

[docs] Add documentation on how to add experiments.

2023-10-19 08:32:03 +00:00

add_uma_metrics.md

Update adding uma metrics documentation

2023-06-05 14:12:36 +00:00

architecture_of_devtools_lazy_loading_features.png

[docs] Reorganize project documentation.

2022-09-01 08:23:39 +00:00

architecture_of_devtools_module_visibility_rules.png

[docs] Reorganize project documentation.

2022-09-01 08:23:39 +00:00

architecture_of_devtools.md

Fix markdown links in architecture documentation

2023-10-12 13:59:51 +00:00

contributing_changes.md

[docs] Streamline documentation.

2023-10-12 12:15:09 +00:00

dependencies.md

[docs] Streamline documentation.

2023-10-12 12:15:09 +00:00

design_guidelines.md

[docs] Mention Danil as Chrome DevTools TL.

2023-06-19 09:53:52 +00:00

design_guidelines.png

[docs] Reorganize project documentation.

2022-09-01 08:23:39 +00:00

devtools-protocol.md

Updated the documentation to improve the accuracy.

2023-06-20 17:58:30 +00:00

get_the_code.md

[docs] Recommend --disable-infobars for local testing

2023-11-30 14:00:41 +00:00

l10n.md

Fix internal links in localization documentation

2023-03-15 11:14:12 +00:00

language_extension_api.md

Enforce language plugin icons to be data URLs

2022-12-16 10:55:19 +00:00

material3_guidelines.md

Add DevTools Material 3 guidelines

2023-11-17 11:14:31 +00:00

navbar.md

[docs] Add link to the Design Documents folder.

2022-09-08 08:21:25 +00:00

OWNERS

Move owners files into config/owners

2021-04-08 12:25:52 +00:00

README.md

Documentation for visual logging.

2023-11-20 16:26:36 +00:00

release_management.md

[docs] Streamline documentation.

2023-10-12 12:15:09 +00:00

resource_management.md

Add documentation for projects, bindings and mappings

2022-01-26 15:44:22 +00:00

testing.md

[docs] Streamline documentation.

2023-10-12 12:15:09 +00:00

uma_metrics.md

[docs] Improve documentation of metrics.

2023-05-26 09:43:39 +00:00

visual_logging.md

[VisualLogging] add instrumentation for Console

2023-11-30 12:17:38 +00:00

README.md

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]

Document Index

Design Documents

See the shared Design Documents folder in the Chromium drive.

General Development

Testing

Architectural Documentation

Chromium

Useful Commands

git cl format --js

Formats all code using clang-format.

npm run check

Runs all static analysis checks on DevTools code.

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

and preview the result by opening http://localhost:8080/docs/README.md in your browser. 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.