Clone this repo:
  1. deee88d Update cros_vm.md. by Achuith Bhandarkar · 6 days ago master
  2. 699f965 docs: with rust/cargo included in the SDK, update install section by Zach Reizner · 4 weeks ago factory-coral-10122.B firmware-coral-10068.B
  3. 2efe4b7 Merge "docs: Add "Chrome OS D-Bus Usage in Chrome" doc." by Dan Erat · 4 weeks ago
  4. 2ef7f6b docs: Add "Chrome OS D-Bus Usage in Chrome" doc. by Daniel Erat · 4 weeks ago
  5. 6579006 Change /var/run paths to /run by Mike Frysinger · 5 weeks ago

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.