openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-26 22:52:34 +02:00
Code Issues Releases Wiki Activity

doc: Clarify that adding docs follows dev process and add into howtos

Browse Source 
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>
This commit is contained in:
Anastasia Klimchuk 2024-02-19 19:48:04 +11:00 committed by Anastasia Klimchuk
parent 8b074c8b7c
commit 49fbdc7dd6
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/contrib_howtos/index.rst
View File

@ -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

5
doc/how_to_add_docs.rst
View File

@ -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.