From 0d6399f351925dffbb729726a99708c7f19aa784 Mon Sep 17 00:00:00 2001
From: RandyGaul <randypgaul@gmail.com>
Date: Sat, 15 Jun 2024 16:22:22 -0700
Subject: [PATCH] docs on editing docs

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 59d6cbc4b..876e0e078 100644
--- a/README.md
+++ b/README.md
@@ -132,3 +132,9 @@ If your sample needs access to files on disk, such as assets like images or audi
 And that's it! Regenerate your project and you will be able to build your new sample. The next step is to add in your sample to [CF's documentation](https://randygaul.github.io/cute_framework/#/samples). You should [edit this file](https://github.com/RandyGaul/cute_framework/blob/master/docs/samples.md) to add your sample to the list of CF samples.
 
 Once confirmed working as intended, open a pull request to add in your new sample!
+
+# Editing the Docs
+
+All of CF's docs for the [CF website](https://randygaul.github.io/cute_framework/#/) are located here in GitHub [under the docs folder](https://github.com/RandyGaul/cute_framework/tree/master/docs). Editing any of these docs is a good way to contribute to CF through a pull-request.
+
+Please note that the reference pages for functions/structs are automatically generated by CF's [docs parser + generator](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can run this executable to regenerate all of the docs files for all of CF. If you wish to edit any of the reference pages be sure to edit the appropriate file in CF's actual source code and regenerate the docs by running the CF sample [docs_parser](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can then create a pull-request for any of the regenerated docs files.