0
Files
src/docs/README.md
Manuel Lagana 1821fff8bf docs: fix collocation error
The usual collocation for "on the web" is "on", not "in".

Change-Id: Ic96cd96a54a01888fa2a41c66eb8a64103ad964a
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3644789
Reviewed-by: Philip Rogers <pdr@chromium.org>
Commit-Queue: Philip Rogers <pdr@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1002756}
2022-05-12 18:30:35 +00:00

22 KiB

Chromium docs

This directory contains chromium 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

Markdown documents must follow the style guide.

Preview local changes using md_browser

# in chromium checkout
./tools/md_browser/md_browser.py

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 browse -> Patchset 3 browse | DOWNLOAD
    at the top left of the page. Click on the second "browse" 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

Checking Out and Building

Design Docs

Integrated Development Environment (IDE) Set Up Guides

Git

Clang

General Development

Testing

Misc Linux-Specific Docs

Misc MacOS-Specific Docs

Misc Windows-Specific Docs

Misc Android-Specific Docs

Misc iOS-Specific Docs

Misc Chrome-OS-Specific Docs

Misc WebUI-Specific Docs

Media

Accessibility

Memory

Memory Infrastructure Timeline Profiling (MemoryInfra)

Metrics

Misc

Mojo & Services

Speed

  • Chrome Speed - Documentation for performance measurements and regressions in Chrome.
  • Chrome Speed Metrics - Documentation about user experience metrics on the web and their JavaScript APIs.

Probably Obsolete