diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml new file mode 100644 index 0000000..2bc2057 --- /dev/null +++ b/.github/workflows/build-docs.yaml @@ -0,0 +1,27 @@ +name: Build and Pack + +on: [push, pull_request] + +jobs: + ######################################################################################### + ## Build the documentation using mkdoc + ## It will be pushed to the gh-pages branch + ######################################################################################### + build-documentation: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-python@v2 + - run: | + pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin + git config user.name 'github-actions[bot]' + git config user.email 'github-actions[bot]@users.noreply.github.com' + - name: Publish docs + run: | + mkdocs gh-deploy diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d97e100 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site \ No newline at end of file diff --git a/README.md b/README.md index 62f0225..a2ff206 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ # AI-on-the-edge-device-docs +This repo contains the documentation for the [AI-on-the-Edge-Device Project](https://github.com/jomjol/AI-on-the-edge-device). + +# How does it work +1. You can edit any `*.md` document in the [docs](docs) folder. +1. Then create a Pull Request for it to merge it into the `main` branch (or edit it directly in the `main` branch if you have the required rights). +1. When it got merged, the [Github Actions](https://github.com/jomjol/AI-on-the-edge-device-docs/actions) will re-generate the documentation and place it in the `gh-pages` branch. This branch automatically gets populated to the public [Documentation Site](https://jomjol.github.io/AI-on-the-edge-device-docs) + +## Migrating existing Wiki Pages +The files from the [AI-on-the-Edge-Device Wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki) got exported and added to this repo. Unless the files are listed in the [docs/nav.yml](docs/nav.yml) file, they will be listed in the **asorted pages** section of the left sidebar. + +In the end, we should review all pages from there step by step and add them to the upper part of the navigation. + +### Tasks to do + - Check the links in the documents + - Fetch included images and place them directly in the [docs/img](docs/img) folder + - Rerwrite to have a clear structure + + +## Adding new files +1. Add a new `*.md` document in the [docs](docs) folder. +1. Add the **filename** to the [docs/nav.yml](docs/nav.yml) at the wished position in the **Links** section. + +## Local Test +To test it locally: +1. Clone this repo +1. Install the required tools: + ``` + pip install --upgrade pip + pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin + ``` +1. 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. \ No newline at end of file diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 0000000..660ac03 Binary files /dev/null and b/docs/img/favicon.ico differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..594621e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ +# Welcome +Welcome to the **AI on the Edge Device** Project Documentation! + +... \ No newline at end of file diff --git a/docs/nav.yml b/docs/nav.yml new file mode 100644 index 0000000..c6f7b0d --- /dev/null +++ b/docs/nav.yml @@ -0,0 +1,16 @@ +# Configure the navigation using following list +# and the Awesome Pages Plugin (https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) + +nav: + # List all files in the expected order + - index.md + + - Links: + - Web Installer/Console: https://jomjol.github.io/AI-on-the-edge-device/index.html + - Place an Issues: https://github.com/jomjol/AI-on-the-edge-device/issues + - Join a Discussions: https://github.com/jomjol/AI-on-the-edge-device/discussions + + - Asorted Pages: + # List all pages which are not covered by above list + # Step by step we should migrate those page to the above list + - ... diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..1cda9e0 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,16 @@ +site_name: AI on the Edge Device + +site_url: https://jomjol.github.io/AI-on-the-edge-device-docs/ +repo_url: https://github.com/jomjol/AI-on-the-edge-device-docs +edit_uri: https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/doc + +theme: readthedocs + +favicon: favicon.ico + +plugins: + - search + - awesome-pages: + filename: nav.yml + +# The navigation is configured in the nav.yml file! \ No newline at end of file