From 49fbdc7dd61a6add01e2de56e379fda54823cbab Mon Sep 17 00:00:00 2001 From: Anastasia Klimchuk Date: Mon, 19 Feb 2024 19:48:04 +1100 Subject: 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 Reviewed-on: https://review.coreboot.org/c/flashrom/+/80631 Tested-by: build bot (Jenkins) Reviewed-by: Stefan Reinauer --- doc/contrib_howtos/index.rst | 1 + doc/how_to_add_docs.rst | 5 +++++ 2 files changed, 6 insertions(+) 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. -- cgit v1.2.3