diff options
| -rw-r--r-- | doc/contrib_howtos/index.rst | 1 | ||||
| -rw-r--r-- | doc/how_to_add_docs.rst | 5 |
2 files changed, 6 insertions, 0 deletions
diff --git a/doc/contrib_howtos/index.rst b/doc/contrib_howtos/index.rst index 59326cd68..b33482da4 100644 --- a/doc/contrib_howtos/index.rst +++ b/doc/contrib_howtos/index.rst @@ -7,3 +7,4 @@ Contributors howtos how_to_add_new_chip how_to_mark_chip_tested how_to_add_unit_test + ../how_to_add_docs diff --git a/doc/how_to_add_docs.rst b/doc/how_to_add_docs.rst index 0b32acbd2..ee99ce71c 100644 --- a/doc/how_to_add_docs.rst +++ b/doc/how_to_add_docs.rst @@ -1,6 +1,11 @@ How to add or update docs ========================= +Documentation files live in ``/doc`` directory in the source tree, so +adding or updating documentation follows the same process as changing +the code. If you've never done it before, start by carefully +reading the :doc:`/dev_guide/development_guide`. + To add or update a documentation page, you need to create or modify an ``.rst`` file in the ``/doc`` directory and send a patch for review. |