Skip to content

Commit

Permalink
remove wiki migration notes
Browse files Browse the repository at this point in the history
  • Loading branch information
caco3 authored Nov 23, 2023
1 parent 6cb4f03 commit 6ec777b
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,6 @@ This repo contains the documentation for the [AI-on-the-Edge-Device Project](htt
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 **assorted 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
- Make sure there is a top level title (#) and all other chapter headers are on lower levels (##, ###)
- Check the links in the documents
- Fetch included images and place them directly in the [docs/img](docs/img) folder
- Rewrite to have a clear structure

## Editing a page
Each page has a link on its top-right corner `Edit on GitHub` which brings you directly to the Github editor.

Expand Down

0 comments on commit 6ec777b

Please sign in to comment.