1How to add or update docs 2========================= 3 4Documentation files live in ``/doc`` directory in the source tree, so 5adding or updating documentation follows the same process as changing 6the code. If you've never done it before, start by carefully 7reading the :doc:`/dev_guide/development_guide`. 8 9To add or update a documentation page, you need to create or modify 10an ``.rst`` file in the ``/doc`` directory and send a patch for 11review. 12 13People who are registered in MAINTAINERS file for doc/ directory will 14be automatically added to the patch as reviewers. However, you are 15very welcome to add more reviewers who know the subject. In fact, it 16is always a good idea to add someone who has knowledge of the specific 17area you are documenting. 18 19We are using Sphinx doc engine for documentation (see 20https://www.sphinx-doc.org/) and reStructured Text format for content. 21reStructuredText Primer page has more details 22https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#restructuredtext-primer 23 24Brand new page needs to be added to the appropriate ``index.rst`` file 25under ``/doc`` directory (that could be a root index file or nested one). 26 27To test your changes, build flashrom with documentation and open 28generated ``.html`` file in the browser. Generated ``.html`` files are 29in meson ``builddir/doc/html`` directory. 30 31Misc questions 32-------------- 33 34* We use CC-BY-4.0 license for documentation. 35* Writing style can be formal or informal, it's mostly up to you, the 36 important thing is to make the text clear, readable and unambiguous. You 37 can insert images if this really helps the readers to understand the 38 instructions. 39* Documentation should be relevant to either flashrom usage or flashrom 40 development 41