AI-on-the-edge-device-docs/README.md

AI-on-the-edge-device-docs

This repo contains the documentation for the AI-on-the-Edge-Device Project.

How does it work

1. You can edit any *.md document in the docs folder.
2. Then create a Pull Request for it to merge it into the main branch.
3. When it got merged, the Github Actions will re-generate the documentation and place it in the gh-pages branch. This branch automatically gets populated to the public Documentation Site

Migrating existing Wiki Pages

The files from the AI-on-the-Edge-Device Wiki got exported and added to this repo. Unless the files are listed in the docs/nav.yml file, they will be listed in the asorted pages section. We should review all pages from there step by step and add them to the navigation.

Tasks to do:

• Check links
• Fetch included images and place them directly in the docs/img folder
• Rerwrite to have a clear structure

Adding new files

1. Add a new *.md document in the docs folder.
2. Add the filename to the docs/nav.yml at the wished position in the Links section.

Local Test

To test it locally:

1. Clone this repo

2. Install the required tools:

   pip install --upgrade pip
   pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin
   

3. In the main folder of the repo, call mkdocs serve (and keep it running). This will locally generate the documentation. You can access it under http://127.0.0.1:8000/AI-on-the-edge-device-docs/

   Any change to the files will automatically be applied.