From 24192a6fa426412fe942630e1318f6aa98c83f2b Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Tue, 3 Jan 2023 08:19:43 +0100 Subject: [PATCH] . --- README.md | 4 +++- mkdocs.yml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83712b2..1d5cd90 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,10 @@ In the end, we should review all pages from there step by step and add them to t - Fetch included images and place them directly in the [docs/img](docs/img) folder - Rerwrite 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. -## Adding new files +## Adding new pages 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. diff --git a/mkdocs.yml b/mkdocs.yml index da0a8f6..d0748c3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ 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 +edit_uri: https://github.com/jomjol/AI-on-the-edge-device-docs/edit/main/docs theme: readthedocs