Merge "docs: Describe how to make changes."
tree: c7dcd553d33e0a3b3a46c21b92ee096f7cc7eec7
  1. chrome_commit_pipeline.md
  2. cros_commit_pipeline.md
  3. dbus_best_practices.md
  4. development_basics.md
  5. README.md
  6. simple_chrome_workflow.md
README.md

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.

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.