chromium/src
0
Fork 0
Code Activity
Files
60d40d86bc788dca9e339ae6d9c1cc5f67b06861
src/docs/README.md
Ming-Ying Chung 99ebfd7cb5 [docs] Move markdown style guide to chromium docs 
It's currently hosted at [chromium project][1] page, which is difficult
to find compared to other style guides listed here.

Will submit another change to redirect from the existing page.

[1]: https://www.chromium.org/developers/markdown-documentation/

Change-Id: Id00ebb7960e9d41e91d6623df9b2d512ee03677b
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4302569
Commit-Queue: John Abd-El-Malek <jam@chromium.org>
Reviewed-by: Kenichi Ishibashi <bashi@chromium.org>
Reviewed-by: John Abd-El-Malek <jam@chromium.org>
Auto-Submit: Ming-Ying Chung <mych@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1112579}
2023-03-03 01:01:48 +00:00

24 KiB
Raw Blame History

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

Guidelines

Previewing changes

Locally using md_browser

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

This is only an estimate. The gitiles view may differ.

Online with Gerrit's links to gitiles

  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

Checking Out and Building

Design Docs

Integrated Development Environment (IDE) Set Up Guides

Git

Clang

General Development

Testing

Configuration Docs

GPU-related docs

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.

UI

Probably Obsolete