Clone this repo:
  1. 83eb526 Merge "docs: Update devmode links in simplechrome" by James Cook · 4 days ago firmware-scribe-10045.B master
  2. dcf3199 sandboxing: update note about autotest baseline tests by Mike Frysinger · 4 days ago
  3. 67e75a4 sandboxing: shorten gerrit links by Mike Frysinger · 5 days ago
  4. 3d13538 docs: Update devmode links in simplechrome by James Cook · 5 days ago
  5. 2a6fee7 docs: use std::make_unique instead of base::MakeUnique in example by Ben Chan · 12 days ago release-R63-10032.B

Chromium OS docs

This directory contains public Chromium OS 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. Feel free to bypass the commit queue and commit changes immediately after they are reviewed.

Making changes without repo

You can also make changes to this repository without using the repo tool. This comes in handy when you don't have a Chromium OS checkout:

git clone https://chromium.googlesource.com/chromiumos/docs
curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg
cd docs
git checkout -b changes
(make some changes)
git commit -a
git push origin HEAD:refs/for/master

The above steps will upload a patch to chromium-review.googlesource.com where you can get your patch reviewed, and submit.

Previewing changes

You can preview your local changes using md_browser:

# at top of Chromium OS checkout
./chromium/src/tools/md_browser/md_browser.py -d docs

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

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.