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 03:57:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

update explanations

Browse Source
This commit is contained in:
CaCO3
2024-01-31 22:54:39 +01:00
parent ab02887491
commit bb0541c0db
3 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

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

2
docs/Build-Instructions.md
View File

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

2
docs/Parameters.md
View File

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