diff options
| author | Anastasia Klimchuk <aklm@flashrom.org> | 2024-02-19 19:48:04 +1100 |
|---|---|---|
| committer | Anastasia Klimchuk <aklm@chromium.org> | 2024-02-23 01:44:26 +0000 |
| commit | 49fbdc7dd61a6add01e2de56e379fda54823cbab (patch) | |
| tree | a76a714b85e01e8e3ed07ef6d5dc64afde2c17f2 | |
| parent | 8b074c8b7c1aeaf3f80a6ba20a6df1d1b8ee6ec5 (diff) | |
| download | flashrom-49fbdc7dd61a6add01e2de56e379fda54823cbab.tar.gz flashrom-49fbdc7dd61a6add01e2de56e379fda54823cbab.tar.bz2 flashrom-49fbdc7dd61a6add01e2de56e379fda54823cbab.zip | |
doc: Clarify that adding docs follows dev process and add into howtos
Also add link to "How to add new doc" into a collection of
Contributors howtos.
The doc stays in root of docs, and also in the main left-side
menu on the website, so that it is very easy to discover. Everyone
who has even the slightest motivation to update the docs, should
be able to find instructions easily.
Change-Id: I882de0614ab76b8e83b0fafa67296526fecd8a16
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/80631
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
| -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. |