Add navigation docs

Jesus7502 · Nov 17, 2019 · 1928ada · 1928ada
1 parent 9aed582
commit 1928ada
Show file tree

Hide file tree

Showing 14 changed files with 126 additions and 12 deletions.
diff --git a/documentation/navigation/installed.md b/documentation/navigation/installed.md
@@ -3,4 +3,17 @@ id: installed
 title: Installed
 ---
 
-Installed
+![nav_installed](/img/nav_installed.png)
+
+This is where you get an overview of your installed repositories.
+
+You will see a status icon that indicates the status of the repository.
+The color of that icon is [cuztomizable with themes](/docs/basic/theming), but the default is:
+
+color | description
+-- | --
+Green | All good
+Orange | Update pending
+Red | Restart pending, or not loaded.
+
+If you hoover over the icon you will also see a short description.
diff --git a/documentation/navigation/overview.md b/documentation/navigation/overview.md
@@ -3,4 +3,15 @@ id: overview
 title: Overview
 ---
 
-Overview
+This is the starting point you get to when you open HACS.
+
+![nav_overview](/img/nav_overview.png)
+
+Every tab you see here serves a seperate purpose:
+
+- [Installed](/docs/navigation/installed) This is where you get an overview of your installed repositories.
+- [Stores (Integrations, plugins, appdaemon apps, python scripts, themes)](/docs/navigation/stores) This is where you can browse and install new repositories
+- [Settings](/docs/navigation/settings) Settings and advanced features for HACS.
+
+
+If you click on a repository under the installed or store tabs, you will get to the page of that [repository](/docs/navigation/repository).
diff --git a/documentation/navigation/repository.md b/documentation/navigation/repository.md
@@ -3,4 +3,46 @@ id: repository
 title: Repository
 ---
 
-Repository
+![nav_repository](/img/nav_repository.png)
+
+This section has two parts Core and Additional
+
+## Core
+
+This part give you core information about the repository:
+
+- Title
+- Desctiption
+- Installed version
+- Available version(s)
+- Author(s)
+
+
+### Repository menu
+
+You get to this by clicking the three vertical dots in the top right corner.
+
+function | description
+-- | --
+Update information | This will reload the information about the repository.
+Show beta | This will enable beta versions for the repository. (Only if the repository uses releases.)
+Hide | This will hide the repository from the store views. (Only if the repository is not custom.)
+Open issue | This will take you to where you can report issues about that repository.
+Flag this | This will take you to a issue template to remove the repository from HACS.
+
+### Repository buttons
+
+button | description
+-- | --
+main action | This button will have a different function depending on the version you have installed if any, but the main part is that it will install the selected version if clicked.
+Change log | This will show you the change log for the repository. (This will only show if there is an update pending)
+Repository | This will take you to the github repository
+Open plugin | This will show you the plugin file that hacs will serve to Lovelace. (This will only show for installed plugins)
+Uninstall | This will stop tracking versions in HACS, and delete the files that HACS has downloaded for it.
+
+## Additional
+
+This part shows more information about the repository.
+At the bottom of this section you will also see where it is/will be installed.
+
+If the repository is a plugin you will also get instructions on how to add it to your Lovelace configuration.
diff --git a/documentation/navigation/settings.md b/documentation/navigation/settings.md
@@ -3,4 +3,43 @@ id: settings
 title: Settings
 ---
 
-Settings
+![nav_settings](/img/nav_settings.png)
+
+The settings tab have 3 sections.
+
+## HACS Information
+
+Here you will see the version of HACS you are running, and how many repositories that HACS have.
+
+You can also change how the layout of the repositories are shown.
+You can choose between "Grid" (default) or "Table".
+
+There are also some buttons here
+
+button | desription
+-- | --
+Reload data | This forces HACS to reload the data of every repository it konws about.
+Upgrade all | This **WILL** upgrade **ALL** your installed repositories, be carefull if you use this.
+HACS Repo | This opens a new tab and takes you to the repository for HACS.
+Open Issue | This takes you to where you can submit issues for HACS.
+
+## Custom repositories
+
+HACS have a lot of repositories in the store by default, but not all are there, if the repository is compliant with the rules that HACS needs for the reposiotry you can add it to HACS as a custom repository.
+
+The first part of this section is a list of all the custom repositories you have added.
+
+The second part is where you can add new repositories.
+
+![new_custom](/img/new_custom.png)
+
+In the left add the repository you wand to add, this can be `https://github.com/developer/repository` or `developer/repository`, then you select the correct category, and click the save icon.
+
+If the repository can be added it will now show in the list, and in the store for you to install it.
+
+
+## Hidden repositories
+
+_If you have not any hidden repositories you will not see this section._
+
+Repositories in this list are hidden from the store tabs, if you have hidden a repository by mistake you can click the reload (unhide) icon and it will once again show up in the store tabs.
diff --git a/documentation/navigation/stores.md b/documentation/navigation/stores.md
@@ -3,4 +3,20 @@ id: stores
 title: Stores
 ---
 
-Stores
+![nav_stores](/img/nav_stores.png)
+
+This is where you can browse and install repositories.
+For the "INTEGRATIONS", "PLUGINS", "APPDAEMON APPS", "PYTHON SCRIPTS" and "THEMES" tabs, the look and features are the same.
+
+## Search
+
+At the top of the page you have a searchbar, here you can search for repositories matching your criteria.
+
+![search](/img/nav_store_search.png)
+
+## New repositories
+
+![new](/img/nav_store_new.png)
+
+When new repositories are added to HACS, you will see them at the top of the store tabs, right below the searchbar.
+If you open the [repository](/docs/navigation/repository) it will be removes as new, or you can click the "CLEAR ALL NEW REPOSITORIES" button to unmark all repositories in that category as new.
diff --git a/sidebars.js b/sidebars.js
@@ -1,10 +1,3 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
 module.exports = {
  "usage": {
  "Basic": [

diff --git a/static/img/nav_installed.png b/static/img/nav_installed.png
diff --git a/static/img/nav_overview.png b/static/img/nav_overview.png
diff --git a/static/img/nav_repository.png b/static/img/nav_repository.png
diff --git a/static/img/nav_settings.png b/static/img/nav_settings.png
diff --git a/static/img/nav_store_new.png b/static/img/nav_store_new.png
diff --git a/static/img/nav_store_search.png b/static/img/nav_store_search.png
diff --git a/static/img/nav_stores.png b/static/img/nav_stores.png
diff --git a/static/img/new_custom.png b/static/img/new_custom.png