mirror of https://github.com/react/react-native-devtools-frontend.git synced 2026-10-30 01:43:36 +08:00

Files

T

Benedikt Meurer 8b830206ff [docs] Move unit testing documentation into a single place.

Previously the `front_end/testing/README.md` also had some pieces of
information relevant for unit tests, but which wasn't referenced from
our documentation index anywhere. Put that into the proper place.

Bug: 333520272
Change-Id: I8e34c1bf192176e674fc1353fcfce40bef0f3030
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5452879
Reviewed-by: Simon Zünd <szuend@chromium.org>
Commit-Queue: Simon Zünd <szuend@chromium.org>
Auto-Submit: Benedikt Meurer <bmeurer@chromium.org>

2024-04-15 10:28:47 +00:00

add_experiments.md

[JS Profiler Deprecation] Non-dismissable deprecation warning

2023-12-15 09:45:02 +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

Move devDependencies to package.json

2024-04-05 06:22:21 +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

[Autoroller] Update roll_deps to also generate protocol resources and run format scripts

2024-01-31 09:16:18 +00:00

get_the_code.md

Fix Mac instructions for running with pre-built chrome

2024-03-14 22:55:24 +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

[test] Move unit test documentation.

2024-02-27 15:11:56 +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

[test] Move unit test documentation.

2024-02-27 15:11:56 +00:00

uma_metrics.md

[docs] Improve documentation of metrics.

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

unit_testing.md

[docs] Move unit testing documentation into a single place.

2024-04-15 10:28:47 +00:00

visual_logging.md

[VE] Update docs to describe context parameter

2024-01-31 13:48:30 +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.