Google Git
Sign in
chromium / chromiumos / docs / 4461519e202a02b121accf533934af52f62e008d / . / README.md
blob: 4547d167a3c7455aadccc988b7dba2f15d243ba6 [file] [log] [blame] [view]
Harry Cutts44615192022-04-21 22:39:14[diff] [blame^]1# ChromiumOS docs
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]2
Harry Cutts44615192022-04-21 22:39:14[diff] [blame^]3This directory contains public [ChromiumOS] project documentation that is
Daniel Eratdd609d32017-04-06 15:23:03[diff] [blame]4automatically [rendered by Gitiles]. The docs are written in [Gitiles-flavored
5Markdown].
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]6
7## General guidelines
8
9See the [Chromium documentation guidelines] and [Chromium documentation best
10practices].
11
12## Style guide
13
14Markdown documents must follow the [style guide].
15
Daniel Erat6bc26782017-06-27 22:59:22[diff] [blame]16## Making changes
17
18This repository is managed by the [repo] tool, so you can make changes to it
19using the same techniques that you'd use for any other repositories in the
Mike Frysinger57ef0072018-10-05 22:49:46[diff] [blame]20project.
Daniel Erat6bc26782017-06-27 22:59:22[diff] [blame]21
Mike Frysinger3aac9b52018-11-15 21:43:32[diff] [blame]22See the [Contributing] guide for more details.
23
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]24## Previewing changes
25
Mike Frysingere5a66892019-02-21 23:10:11[diff] [blame]26You can preview your local changes using `scripts/preview_docs` which utilizes
27[Gerrit sandbox branches]:
Lann Martinba704b82018-07-19 16:29:03[diff] [blame]28
29```bash
30scripts/preview_docs README.md
31```
32
33You can also use [md_browser], which is entirely local and does not require
34refs/sandbox/ push permission, but has somewhat inaccurate rendering:
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]35
36```bash
Harry Cutts44615192022-04-21 22:39:14[diff] [blame^]37# at top of ChromiumOS checkout
Mike Frysingerd1cbd282019-03-07 06:27:13[diff] [blame]38./src/chromium/src/tools/md_browser/md_browser.py -d docs
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]39```
40
41Then browse to e.g.
42[http://localhost:8080/README.md](http://localhost:8080/README.md).
43
Daniel Erat6bc26782017-06-27 22:59:22[diff] [blame]44To review someone else's changes, apply them locally first, or just click the
45`gitiles` link near the top of a Gerrit file diff page.
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]46
Harry Cutts44615192022-04-21 22:39:14[diff] [blame^]47[ChromiumOS]: https://www.chromium.org/chromium-os
Mike Frysinger3aac9b52018-11-15 21:43:32[diff] [blame]48[Contributing]: contributing.md
Mike Frysinger9fc0fc02020-09-05 05:18:57[diff] [blame]49[rendered by Gitiles]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/
Mike Frysingere5a66892019-02-21 23:10:11[diff] [blame]50[Gerrit sandbox branches]: contributing.md#sandbox
Mike Frysinger9fc0fc02020-09-05 05:18:57[diff] [blame]51[Gitiles-flavored Markdown]: https://gerrit.googlesource.com/gitiles/+/HEAD/Documentation/markdown.md
52[Chromium documentation guidelines]: https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_guidelines.md
53[Chromium documentation best practices]: https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_best_practices.md
Daniel Eratc10be9e2017-03-07 01:51:49[diff] [blame]54[style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide
Daniel Erat6bc26782017-06-27 22:59:22[diff] [blame]55[repo]: https://source.android.com/source/using-repo
Satoru Takabayashi38520822017-06-28 05:01:07[diff] [blame]56[chromium-review.googlesource.com]: https://chromium-review.googlesource.com/
Mike Frysinger9fc0fc02020-09-05 05:18:57[diff] [blame]57[md_browser]: https://chromium.googlesource.com/chromium/src/tools/md_browser/