Skip to content

Commit

Permalink
Update documentation path
Browse files Browse the repository at this point in the history
  • Loading branch information
timmo001 committed Jun 19, 2020
1 parent c555529 commit 3fc5e9f
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 17 deletions.
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ backend/tsconfig.json
config.template.json
docker-compose*
Dockerfile*
docs/
documentation/
frontend/public/
frontend/src/
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
6 changes: 3 additions & 3 deletions documentation/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
4 changes: 2 additions & 2 deletions documentation/docs/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions documentation/docs/showcase/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
2 changes: 1 addition & 1 deletion documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 3fc5e9f

Please sign in to comment.