Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-07 12:07:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
CaCO3
2024-08-17 23:57:49 +02:00
committed by GitHub
parent 9eacbec2f7
commit 03d426497a
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -17,13 +17,15 @@ Each page has a link on its top-right corner `Edit on GitHub` which brings you d
1. Add the **filename** to the [docs/nav.yml](docs/nav.yml) at the wished position in the **Links** section.
## Parameter Documentation
Each parameter which is listed in the [configfile](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/sd-card/config/config.ini) in the main project repo
has its own description page in the folder `param-docs/parameter-pages` (grouped by the config sections).
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.
Each parameter in the [main project repo](https://github.com/jomjol/AI-on-the-edge-device) is documented in a separate file, see https://github.com/jomjol/AI-on-the-edge-device/tree/rolling/param-docs. The script in `param-docs/concat-parameter-pages.py` collects them and compiles it into the documentation as provided in https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters.
The script should be run whenever one of the pages changed.
This happens automatically daily in the Github action.
if you run it manually, make sure to clone the main repo first, eg. using:
```bash
cd param-docs
git clone https://github.com/jomjol/AI-on-the-edge-device.git
python concat-parameter-pages.py
```
### Template Generator
The script `generate-template-param-doc-pages.py` should be run whenever a new parameter gets added to the config file.