Various Chromium OS docs written in markdown with no other home!

Clone this repo:
  1. c6843c8 OWNERS: switch away from * by Mike Frysinger · 19 hours ago main
  2. 4410f9f kernel_development: add msgid:// to FROMLIST instructions by Paramjit Oberoi · 36 hours ago
  3. 30227dc closed_source: Document security guidelines for third-party binaries. by Paramjit Oberoi · 2 days ago
  4. de36bd5 selinux: Clarifying definitions and some sentences by Ted Brandston · 3 days ago
  5. 2e1a789 firmware_test_manual: Add flashing via futility. by Kevin Shelton · 9 days ago

ChromiumOS docs

This directory contains public ChromiumOS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.

General guidelines

See the Chromium documentation guidelines and Chromium documentation best practices.

Style guide

Markdown documents must follow the style guide.

Making changes

This repository is managed by the repo tool, so you can make changes to it using the same techniques that you'd use for any other repositories in the project.

See the Contributing guide for more details.

Previewing changes

You can preview your local changes using scripts/preview_docs which utilizes Gerrit sandbox branches:


You can also use md_browser, which is entirely local and does not require refs/sandbox/ push permission, but has somewhat inaccurate rendering:

# at top of ChromiumOS checkout
./src/chromium/src/tools/md_browser/ -d docs

Then browse to e.g. http://localhost:8080/

To review someone else's changes, apply them locally first, or just click the gitiles link near the top of a Gerrit file diff page.