diff --git a/.dockerignore b/.dockerignore index ee97907e2..65d947989 100644 --- a/.dockerignore +++ b/.dockerignore @@ -24,7 +24,6 @@ backend/tsconfig.json config.template.json docker-compose* Dockerfile* -docs/ documentation/ frontend/public/ frontend/src/ diff --git a/README.md b/README.md index ebf2e7d82..d23dd50d3 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Setup and configuration for the app is available [here][setup-docs] [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg -[banner]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/banner.png +[banner]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/banner.png [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg [buymeacoffee]: https://www.buymeacoffee.com/timmo [code-of-conduct]: https://github.com/timmo001/home-panel/blob/master/.github/CODE_OF_CONDUCT.md @@ -80,8 +80,8 @@ Setup and configuration for the app is available [here][setup-docs] [pulls-shield]: https://img.shields.io/docker/pulls/timmo001/home-panel.svg [releases-shield]: https://img.shields.io/github/release/timmo001/home-panel.svg [releases]: https://github.com/timmo001/home-panel/releases -[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-main.png -[screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-main.png +[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-configuration-main.png +[screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-main.png [setup-docs]: https://timmo.dev/home-panel/setup/ -[showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/docs/showcase/timmo/purple-space.png +[showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/documentation/showcase/timmo/purple-space.png [version-shield]: https://images.microbadger.com/badges/version/timmo001/home-panel.svg diff --git a/documentation/docs/configuration.md b/documentation/docs/configuration.md index 33f9142f6..0aaafcca7 100644 --- a/documentation/docs/configuration.md +++ b/documentation/docs/configuration.md @@ -23,7 +23,7 @@ From here you can change things like the base, primary color palette, will grab an image from unsplash with any image containing the word space: `url(https://source.unsplash.com/1920x1080/?space)` -[screen-configuration-header]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-header.png -[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-main.png -[screen-configuration-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-theme.gif +[screen-configuration-header]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-configuration-header.png +[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-configuration-main.png +[screen-configuration-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-configuration-theme.gif [css-background-property]: https://www.w3schools.com/cssref/css3_pr_background.asp diff --git a/documentation/docs/index.md b/documentation/docs/index.md index 0126b7ff6..94bff9a51 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -51,7 +51,7 @@ A web frontend for controlling the home. Integrates with [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg -[banner]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/banner.png +[banner]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/banner.png [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg [buymeacoffee]: https://www.buymeacoffee.com/timmo [code_of_conduct]: https://github.com/timmo001/home-panel/blob/master/.github/CODE_OF_CONDUCT.md @@ -70,8 +70,8 @@ A web frontend for controlling the home. Integrates with [pulls-shield]: https://img.shields.io/docker/pulls/timmo001/home-panel.svg [releases-shield]: https://img.shields.io/github/release/timmo001/home-panel.svg [releases]: https://github.com/timmo001/home-panel/releases -[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-main.png -[screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-main.png +[screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-configuration-main.png +[screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-main.png [setup-docs]: https://timmo.dev/home-panel/setup/ -[showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/docs/showcase/timmo/purple-space.png +[showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/documentation/showcase/timmo/purple-space.png [version-shield]: https://images.microbadger.com/badges/version/timmo001/home-panel.svg diff --git a/documentation/docs/login.md b/documentation/docs/login.md index 24f62349d..05139cdbc 100644 --- a/documentation/docs/login.md +++ b/documentation/docs/login.md @@ -41,5 +41,5 @@ Enter your username and password you used previously and click `Log In`. ![Account Login Screen Screenshot][screen-account-login] -[screen-account-creation]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-account-creation.png -[screen-account-login]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-account-login.png +[screen-account-creation]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-account-creation.png +[screen-account-login]: https://raw.githubusercontent.com/timmo001/home-panel/master/documentation/resources/screen-account-login.png diff --git a/documentation/docs/showcase/contributing.md b/documentation/docs/showcase/contributing.md index 003c1e9aa..61fe11ede 100644 --- a/documentation/docs/showcase/contributing.md +++ b/documentation/docs/showcase/contributing.md @@ -12,7 +12,7 @@ If you would like to showcase your own setup, submit a PR to the repository information using [timmo.md][timmo.md] as a simple example. 1. If possible, add a 'how I did it' section to your file explaining how to replicate, for example, your theme. -1. Finally, add your file's name and path to the `docs/mkdocs.yml` file in +1. Finally, add your file's name and path to the `documentation/mkdocs.yml` file in the navigation section. Once again use my example and make a new line at the end. This will allow [mkdocs] to see your file and add it to the navigation of the documentation @@ -24,6 +24,6 @@ If you would like to showcase your own setup, submit a PR to the repository [code_of_conduct]: https://github.com/timmo001/home-panel/blob/master/.github/CODE_OF_CONDUCT.md [contributing]: https://github.com/timmo001/home-panel/blob/master/.github/CONTRIBUTING.md -[directory]: https://github.com/timmo001/home-panel/tree/master/docs/docs/showcase +[directory]: https://github.com/timmo001/home-panel/tree/master/documentation/docs/showcase [mkdocs]: https://www.mkdocs.org [timmo.md]: timmo/timmo.md diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index ecfd6629b..edcaba24c 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -7,7 +7,7 @@ site_url: https://timmo.dev/home-panel/ # Repository repo_name: timmo001/home-panel repo_url: https://github.com/timmo001/home-panel -edit_uri: "https://github.com/timmo001/home-panel/edit/master/docs/docs" +edit_uri: "https://github.com/timmo001/home-panel/edit/master/documentation/docs" # Copyright copyright: "Copyright © Timmo"