From bb0541c0dbe0faa7c7a441dd02c4db4fb36faeb9 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Wed, 31 Jan 2024 22:54:39 +0100 Subject: [PATCH] update explanations --- README.md | 1 + docs/Build-Instructions.md | 2 +- docs/Parameters.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e2452fe..f84488a 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ has its own description page in the folder `param-docs/parameter-pages` (grouped Those pages can be edited as needed. The script `concat-parameter-pages.py` in `param-docs` should be run whenever one of the pages changed. +This happens automatically in the Github action. It then concatenates all pages into the single `../docs/Parameters.md` which gets be added to the `mkdocs` documentation. ### Template Generator diff --git a/docs/Build-Instructions.md b/docs/Build-Instructions.md index 99d5307..84d39c2 100644 --- a/docs/Build-Instructions.md +++ b/docs/Build-Instructions.md @@ -1,2 +1,2 @@ # Build the Project -See [README.md](https://github.com/jomjol/AI-on-the-edge-device/blob/master/code/README.md) +See [README.md](https://github.com/jomjol/AI-on-the-edge-device/blob/master/code/README.md) in the main repo. diff --git a/docs/Parameters.md b/docs/Parameters.md index 907956c..f1e985e 100644 --- a/docs/Parameters.md +++ b/docs/Parameters.md @@ -1,4 +1,4 @@ # Parameters -:bangbang: This is just a dummy page! It gets automatically replaced by a concatenated list of all pages in [/param-docs/parameter-pages](https://github.com/jomjol/AI-on-the-edge-device-docs/tree/main/param-docs/parameter-pages)! +:bangbang: This is just a dummy page! It gets automatically replaced by a concatenated list of all pages in the main repo (https://github.com/jomjol/AI-on-the-edge-device/tree/rolling/param-docs)! See the [Readme](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md#parameter-documentation) for details!