tree: 058279672bebcf956dfc6a81bdfe171b9fbd1b0b [path history] [tgz]
  1. constants/
  2. design_docs/
  3. firmware/
  4. images/
  5. manatee/
  6. packages/
  7. portage/
  8. scripts/
  9. security/
  10. styleguide/
  11. testing/
  12. .gitignore
  13. adding_builder_variants.md
  14. archive_mirrors.md
  15. breakages_and_flakes.md
  16. ca_certs.md
  17. chrome_commit_pipeline.md
  18. chromeos_gn.md
  19. chroot-clangd-guide.md
  20. contact.md
  21. containers_and_vms.md
  22. contributing.md
  23. cros_commit_pipeline.md
  24. cros_deploy.md
  25. cros_flash.md
  26. cros_tools.md
  27. cros_vm.md
  28. crostini_developer_guide.md
  29. dbus_best_practices.md
  30. dbus_in_chrome.md
  31. debug_buttons.md
  32. developer_guide.md
  33. developer_mode.md
  34. development_basics.md
  35. dir_metadata.md
  36. disk_format.md
  37. eol_aue_process.md
  38. firmware_code_reviews.md
  39. firmware_test_manual.md
  40. firmware_ui.md
  41. git_and_gerrit_intro.md
  42. glossary.md
  43. gsutil.md
  44. input_stack.md
  45. kernel_development.md
  46. kernel_faq.md
  47. kernel_scheduler.md
  48. kernel_tips_and_tricks.md
  49. large_scale_changes.md
  50. life_of_a_bug.md
  51. logging.md
  52. lsb-release.md
  53. lsc_workflow.md
  54. navbar.md
  55. os_config.md
  56. OWNERS
  57. pd_firmware_update.md
  58. platform2_primer.md
  59. platform_public_tracker.md
  60. PRESUBMIT.cfg
  61. PRESUBMIT.sh
  62. README.md
  63. releases.md
  64. remote_trybots.md
  65. repo-tool.md
  66. reporting_bugs.md
  67. rust_on_cros.md
  68. sandboxing.md
  69. security_review_howto.md
  70. security_severity_guidelines.md
  71. simple_chrome_workflow.md
  72. source_layout.md
  73. stack_traces.md
  74. test_install_configuration.md
  75. tips-and-tricks.md
  76. unblocked_terms.txt
  77. work_on_branch.md
  78. write_protection.md
  79. xbuddy.md
README.md

ChromiumOS docs

This directory contains public ChromiumOS 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.

Previewing changes

You can preview your local changes using scripts/preview_docs which utilizes Gerrit sandbox branches:

scripts/preview_docs README.md

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 ChromiumOS 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.