Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / chromiumos / docs / 74c33df8410d89cd97ea6654223da95de9067947
commit74c33df8410d89cd97ea6654223da95de9067947[log] [tgz]
authorCristina Guerrero <crisguerrero@chromium.org>Thu Feb 03 14:08:07 2022 +0000
committerCommit Bot <commit-bot@chromium.org>Thu Feb 03 22:06:36 2022 +0000
tree4f94dce1c221aa57044ff391818c8557cb9c7bc0
parenta07ada398557d238637072318a73175a913f2a6c [diff]
developer_guide: Address style issues and format

Address format issues raised in crrev.com/c/3401856
after submission: add missing blank line after note
element and move new note from popout block to side
notes.

BUG=None
TEST=Preview

Change-Id: I0ad0d64cc8183f3661696f51c07263bbb6fa7e6b
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/3437025
Tested-by: Cristina Guerrero <crisguerrero@chromium.org>
Auto-Submit: Cristina Guerrero <crisguerrero@chromium.org>
Reviewed-by: Mike Frysinger <vapier@chromium.org>
Commit-Queue: Mike Frysinger <vapier@chromium.org>
1 file changed
tree: 4f94dce1c221aa57044ff391818c8557cb9c7bc0
  1. constants/
  2. design_docs/
  3. firmware/
  4. images/
  5. manatee/
  6. packages/
  7. portage/
  8. scripts/
  9. security/
  10. styleguide/
  11. testing/
  12. PRESUBMIT.py ⇨ ../chromite/PRESUBMIT.py
  13. .gitignore
  14. adding_builder_variants.md
  15. archive_mirrors.md
  16. breakages_and_flakes.md
  17. ca_certs.md
  18. chrome_commit_pipeline.md
  19. chromeos_gn.md
  20. chroot-clangd-guide.md
  21. contact.md
  22. containers_and_vms.md
  23. contributing.md
  24. cros_commit_pipeline.md
  25. cros_deploy.md
  26. cros_flash.md
  27. cros_tools.md
  28. cros_vm.md
  29. crostini_developer_guide.md
  30. dbus_best_practices.md
  31. dbus_in_chrome.md
  32. debug_buttons.md
  33. developer_guide.md
  34. developer_mode.md
  35. development_basics.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_tips_and_tricks.md
  48. large_scale_changes.md
  49. life_of_a_bug.md
  50. logging.md
  51. lsb-release.md
  52. lsc_workflow.md
  53. navbar.md
  54. os_config.md
  55. OWNERS
  56. pd_firmware_update.md
  57. platform2_primer.md
  58. platform_public_tracker.md
  59. PRESUBMIT.cfg
  60. PRESUBMIT.sh
  61. README.md
  62. remote_trybots.md
  63. repo-tool.md
  64. reporting_bugs.md
  65. rust_on_cros.md
  66. sandboxing.md
  67. security_review_howto.md
  68. security_severity_guidelines.md
  69. simple_chrome_workflow.md
  70. source_layout.md
  71. stack_traces.md
  72. test_install_configuration.md
  73. tips-and-tricks.md
  74. unblocked_terms.txt
  75. work_on_branch.md
  76. write_protection.md
  77. xbuddy.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.

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