| nodir | 469b2a1 | 2015-09-14 16:20:21 | [diff] [blame] | 1 | # Chromium docs |
| 2 | |
| pwnall | 3f91838 | 2016-11-16 17:22:12 | [diff] [blame] | 3 | This directory contains chromium project documentation in |
| Vincent Scheib | de853a0 | 2017-07-13 23:31:18 | [diff] [blame] | 4 | [Gitiles-flavored Markdown]. It is automatically [rendered by Gitiles]. |
| 5 | |
| 6 | [Gitiles-flavored Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md |
| 7 | [rendered by Gitiles]: https://chromium.googlesource.com/chromium/src/+/master/docs/ |
| nodir | 469b2a1 | 2015-09-14 16:20:21 | [diff] [blame] | 8 | |
| justincarlson | 90a1c8c | 2017-04-14 00:34:25 | [diff] [blame] | 9 | If you add new documents, please also add a link to them in the Document Index |
| 10 | below. |
| 11 | |
| 12 | [TOC] |
| 13 | |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 14 | ## Creating Documentation |
| nodir | 469b2a1 | 2015-09-14 16:20:21 | [diff] [blame] | 15 | |
| Vincent Scheib | de853a0 | 2017-07-13 23:31:18 | [diff] [blame] | 16 | Markdown documents must follow the |
| 17 | [style guide](https://github.com/google/styleguide/tree/gh-pages/docguide). |
| nodir | 469b2a1 | 2015-09-14 16:20:21 | [diff] [blame] | 18 | |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 19 | ### Preview local changes using [md_browser](../tools/md_browser/): |
| nodir | 6efa499 | 2015-12-20 00:54:33 | [diff] [blame] | 20 | |
| 21 | ```bash |
| 22 | # in chromium checkout |
| agable | d40b954 | 2016-05-11 01:15:06 | [diff] [blame] | 23 | ./tools/md_browser/md_browser.py |
| nodir | 6efa499 | 2015-12-20 00:54:33 | [diff] [blame] | 24 | ``` |
| 25 | |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 26 | This is only an estimate. The **gitiles** view may differ. |
| nodir | 6efa499 | 2015-12-20 00:54:33 | [diff] [blame] | 27 | |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 28 | ### Review changes online with gerrit's links to gitiles: |
| 29 | |
| Mathieu Perreault | 33962538 | 2017-07-29 00:32:58 | [diff] [blame] | 30 | 1. Upload a patch to gerrit, or receive a review request. |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 31 | e.g. https://chromium-review.googlesource.com/c/572236 |
| Mathieu Perreault | 33962538 | 2017-07-29 00:32:58 | [diff] [blame] | 32 | 2. View a specific .md file. |
| Vincent Scheib | 394b907a | 2017-07-14 22:30:06 | [diff] [blame] | 33 | e.g. https://chromium-review.googlesource.com/c/572236/2/docs/README.md |
| 34 | 3. Click on **gitiles** link at top of page. |
| 35 | |
| 36 | This **gitiles** view is the authoritative view, exactly the same as will be |
| 37 | used when committed. |
| nodir | 6efa499 | 2015-12-20 00:54:33 | [diff] [blame] | 38 | |
| justincarlson | 90a1c8c | 2017-04-14 00:34:25 | [diff] [blame] | 39 | ## Document Index |
|
|
