This directory contains public Chromium OS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.
See the Chromium documentation guidelines and Chromium documentation best practices.
Markdown documents must follow the style guide.
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.
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 cd docs curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg chmod +x .git/hooks/commit-msg 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.
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/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.