From fd3475ea3e749af1a43697086214c5059671af46 Mon Sep 17 00:00:00 2001
From: Kim De Mey <kim.demey@gmail.com>
Date: Thu, 12 Sep 2024 10:50:45 +0200
Subject: [PATCH] Add a brief doc page on how to add documentation (#2617)

---
 .../the_fluffy_book/docs/adding-documentation.md | 16 ++++++++++++++++
 fluffy/docs/the_fluffy_book/mkdocs.yml           |  1 +
 2 files changed, 17 insertions(+)
 create mode 100644 fluffy/docs/the_fluffy_book/docs/adding-documentation.md

diff --git a/fluffy/docs/the_fluffy_book/docs/adding-documentation.md b/fluffy/docs/the_fluffy_book/docs/adding-documentation.md
new file mode 100644
index 000000000..d5b6c98fa
--- /dev/null
+++ b/fluffy/docs/the_fluffy_book/docs/adding-documentation.md
@@ -0,0 +1,16 @@
+# Adding Documentation
+
+The documentation visible on [https://fluffy.guide](https://fluffy.guide) is generated with [mkdocs](https://www.mkdocs.org/getting-started/).
+
+If you want to be able to dry run any changes you make, you best install mkdocs locally.
+
+All the documentation related files can be found under the `./fluffy/docs/the_fluffy_book` directory.
+
+## How to test and add documentation changes
+
+- Install `mkdocs`
+- Make your changes to the documentation
+- Run `mkdocs serve` from the `./fluffy/docs/the_fluffy_book` directory and test your changes. Alter as required.
+- Push your changes to a PR on nimbus-eth1
+
+When the PR gets merged, a CI job will run that deploys automatically the changes to [https://fluffy.guide](https://fluffy.guide).
diff --git a/fluffy/docs/the_fluffy_book/mkdocs.yml b/fluffy/docs/the_fluffy_book/mkdocs.yml
index 0b406ea6d..aa5b73220 100644
--- a/fluffy/docs/the_fluffy_book/mkdocs.yml
+++ b/fluffy/docs/the_fluffy_book/mkdocs.yml
@@ -78,6 +78,7 @@ nav:
   - Developers:
     - 'basics-for-developers.md'
     - 'test-suite.md'
+    - 'adding-documentation.md'
     - Local testnet:
       - 'run-local-testnet.md'
       - 'testnet-history-network.md'