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

Clone this repo:
  1. 8edec95 contributing: better 'TEST=' examples by Nicolas Norvez · 4 days ago master
  2. 3e7e0a0 contributing: fix outdated link to glossary by Nicolas Norvez · 4 days ago
  3. 6337334 fuzzing: Add details about supressing errors in source code. by Manoj Gupta · 4 days ago
  4. bd6cf24 kernel_faq: update indentation by Brian Norris · 5 days ago
  5. 79c0b3d fuzzing: Add details about suppressing fuzzer errors. by Manoj Gupta · 6 days 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.

See the Contributing guide for more details.

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
curl -Lo .git/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 where you can get your patch reviewed, and submit.

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 Chromium OS 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.