Anastasia Klimchuk has submitted this change. ( https://review.coreboot.org/c/flashrom/+/80631?usp=email )
Change subject: doc: Clarify that adding docs follows dev process and add into howtos ......................................................................
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 --- M doc/contrib_howtos/index.rst M doc/how_to_add_docs.rst 2 files changed, 6 insertions(+), 0 deletions(-)
Approvals: build bot (Jenkins): Verified Stefan Reinauer: Looks good to me, approved
diff --git a/doc/contrib_howtos/index.rst b/doc/contrib_howtos/index.rst index 59326cd..b33482d 100644 --- a/doc/contrib_howtos/index.rst +++ b/doc/contrib_howtos/index.rst @@ -7,3 +7,4 @@ 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 0b32acb..ee99ce7 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.