typo/grammar fixes (#12)

* Update installed.md typo fix * Patch 16 (#2) * Update theming docs * Update automation.md typo/grammar * Patch 15 (#3) * Update theming docs * Update events.md typo/grammar * Patch 14 (#4) * Update theming docs * Update sensor.md typo/grammar * Patch 13 (#5) * Update theming docs * Update startup.md typo/grammar * Patch 12 (#6) * Update theming docs * Update existing_elements.md typo/grammar * Patch 11 (#7) * Update theming docs * Update getting_started.md typo/grammar * Patch 10 (#8) * Update theming docs * Update themes.md typo/grammar * Patch 9 (#9) * Update theming docs * Update python_scripts.md typo/grammar * Patch 8 (#10) * Update theming docs * Update appdaemon_apps.md typo/grammar * Patch 7 (#11) * Update theming docs * Update plugins.md typo/grammar * Patch 6 (#12) * Update theming docs * Update integrations.md typo/grammar * Patch 5 (#13) * Update theming docs * Update repository.md typo fix * Patch 4 (#14) * Update theming docs * Update settings.md typo/grammar * Update stores.md (#15) typo / grammar fix * Update overview.md (#16) typo fix * Update existing_elements.md * Update getting_started.md * Update sensor.md * Update theming.md
hacs · Nov 22, 2019 · c3fc2a3 · c3fc2a3
1 parent a633d5c
commit c3fc2a3
Show file tree

Hide file tree

Showing 17 changed files with 73 additions and 79 deletions.
diff --git a/documentation/basic/automation.md b/documentation/basic/automation.md
@@ -3,7 +3,7 @@ id: automation
 title: Automation
 ---
 
-Here is a few simple automation examples of what you can do with the data that HACS gives you.
+Here are two simple automation examples of what you can do with the data that HACS provides:
 
 ## New repositories added
 
@@ -56,4 +56,4 @@ automation hacs_updates:
           {% for repo in state_attr(trigger.entity_id, 'repositories') %}
             **{{ repo.display_name }}** _{{ repo["installed version"] }}_ -> _{{ repo["available version"] }}_
           {% endfor %}
-```
+```
diff --git a/documentation/basic/events.md b/documentation/basic/events.md
@@ -3,7 +3,7 @@ id: events
 title: Events
 ---
 
-When HACS operate it will fire some events that the frontend listens to.
+When HACS operates it fires events for the frontend to listen to.
 
 These events can also be used in automations.
 

diff --git a/documentation/basic/existing_elements.md b/documentation/basic/existing_elements.md
@@ -3,8 +3,8 @@ id: existing_elements
 title: Existing elements
 ---
 
-This will not scan you local file system for existing elements.
+HACS will not scan the local file system for existing elements.
 
-Why?
+Why not?
 
-Trust. If this did not download it, there'd be no way to know which version you have, so for elements you already have you will still need to click the "INSTALL" button for that element.
+Trust. If HACS did not initially download the element, there's no way to know which version you have. As a result, existing elements will need to be "INSTALLED" via HACS.
diff --git a/documentation/basic/getting_started.md b/documentation/basic/getting_started.md
@@ -9,16 +9,14 @@ title: Getting started
 
 ## What can HACS do?
 
-This is a manager for your custom Home Assistant needs.
+HACS is a manager for installing and maintaining custom elements for Home Assistant.
 
-It can help you download and update elements.
-
-It can also help you discover new awesome stuff.
+It can help you download and update elements, and can also help you discover new and awesome stuff!
 
 ### What can it track/discover?
 
 - Custom integrations (components/platforms/custom_component) for Home Assistant
 - Custom plugins (cards/rows/mods) for Lovelace
 - AppDaemon apps for [AppDaemon](https://appdaemon.readthedocs.io/en/latest/)
 - Themes for the [frontend integration](https://www.home-assistant.io/components/frontend/) in Home Assistant
-- "python_scripts" for the [`python_scripts` integration](https://www.home-assistant.io/components/python_script/) in Home Assistant
+- "python_scripts" for the [`python_scripts` integration](https://www.home-assistant.io/components/python_script/) in Home Assistant
diff --git a/documentation/basic/sensor.md b/documentation/basic/sensor.md
@@ -3,11 +3,11 @@ id: sensor
 title: Sensor
 ---
 
-During the setup HACS will add a new sensor to your installation (`sensor.hacs`).
-This will have the number of pending updates as the state.
+During setup HACS will add a new sensor to your installation (`sensor.hacs`).
+The state of `sensor.hacs` is the number of pending updates.
 
-As attributes ther is a list of objects that you can use for display and/or automations.
+The HACS sensor also has several attributes that can be used for display and/or automation.
 
 [Have a look here for automation examples](basic/automation.md)
 
-![sensor](https://user-images.githubusercontent.com/15093472/59136215-5ff29d00-8982-11e9-860f-75d382a4d3b7.png)
+![sensor](https://user-images.githubusercontent.com/15093472/59136215-5ff29d00-8982-11e9-860f-75d382a4d3b7.png)
diff --git a/documentation/basic/startup.md b/documentation/basic/startup.md
@@ -3,9 +3,9 @@ id: startup
 title: Startup
 ---
 
-During the startup it will scan for know repositories, and there will be a progressbar indicating that it's working.
+During startup HACS will scan for known repositories, with a progress bar indicating that it's working.
 
 ![startup](/img/bg_task.PNG)
 
-This is completely normal, and you can still use it while it's working.
-The same indication will show when a scheduled task is running.
+This is completely normal, and HACS is still usable while it's working.
+The same indication will show when a scheduled task is running.
diff --git a/documentation/basic/theming.md b/documentation/basic/theming.md
@@ -11,8 +11,8 @@ HACS will try to match your Home Assistant theme as much as possible. There are
 | `hacs-status-installed`  | Controls the icon color for installed, up-to-date repositories  |
 | `hacs-status-pending-restart`  | Controls the icon color for installed repositories that are awaiting a Home Assistant restart  |
 | `hacs-status-pending-update`  | Controls the icon color for installed repositories that have an update available  |
-| `hacs-status-not-loaded`  | Controls the icon color for not loaded repositories that have an update available  |
+| `hacs-status-not-loaded`  | Controls the icon color for repositories that is not loaded  |
 
 Here's a basic example of customizing one of these variables in `themes.yaml`:
 
-`hacs-badge-text-color: "var(--text-primary-color)"`
+`hacs-badge-text-color: "var(--text-primary-color)"`
diff --git a/documentation/categories/appdaemon_apps.md b/documentation/categories/appdaemon_apps.md
@@ -17,23 +17,23 @@ Add a checkmark to the left of AppDaemon apps in the UI configuration for HACS.
 
 ![configuration](/img/conf4.png)
 
-[For more about configure HACS with the UI have a look here](configuration/basic.md)
+[For more about configuring HACS with the UI have a look here](configuration/basic.md)
 
-### Enable if you used the YAML to configure HACS
+### Enable if you used YAML to configure HACS
 
-If you used YAML to configure HACS, add this under your HACS connfiguration to enable AppDaemon apps.
+If you used YAML to configure HACS, add this under your HACS configuration to enable AppDaemon apps:
 
 ```yaml
 hacs:
   ...
   appdaemon: true
 ```
 
-When you have done that you need to restart Home Assistant.
+After adding that you need to restart Home Assistant.
 
-[For more about configure HACS with YAML have a look here](configuration/legacy.md)
+[For more about configuring HACS with YAML have a look here](configuration/legacy.md)
 
 
 ## AppDaemon apps download location
 
-All the AppDaemon apps you download with HACS is stored in `appdaemon/apps/` in your Home Assistant configuration directory.
+Any AppDaemon app downloaded with HACS is stored in `appdaemon/apps/` in your Home Assistant configuration directory.
diff --git a/documentation/categories/integrations.md b/documentation/categories/integrations.md
@@ -3,20 +3,20 @@ id: integrations
 title: Integrations
 ---
 
-Integratons in HACS (or custom_components as they often are refered to) are community built integrations.
+Integrations in HACS (or custom_components as they are often referred to) are community-built integrations.
 
 ## Special notes about Integrations
 
 When you install, update or uninstall an integration in HACS, you need to restart Home Assistant.
 
-There is 1 exception to this.
-If the integration support configuration with `config_flow`, you do not have to restart Home Assistant after the intallation.
+There is 1 exception to this:
+If the integration supports configuration with `config_flow`, you do not have to restart Home Assistant after the intallation.
 You can go straight to the "Configuration" section of the UI, then to "Integrations".
 
 You _may_ need to clear your browser cache before you see it in the "+" list.
 
-_Note that this **only** applies for the installation and initial configuration of that Integration, if you update it, you still need to restart Home Asstant before it loads the new files._
+_Note that this **only** applies for the installation and initial configuration of that Integration, if you update it, you still need to restart Home Assistant before it loads the new files._
 
 ## Integrations download location
 
-All the Integrations you download with HACS is stored in `custom_components/` in your Home Assistant configuration directory.
+Any Integration you download with HACS is stored in `custom_components/` in your Home Assistant configuration directory.
diff --git a/documentation/categories/plugins.md b/documentation/categories/plugins.md
@@ -7,12 +7,12 @@ The [Lovelace UI](https://www.home-assistant.io/lovelace/) is a customizable int
 
 ## Lovelace Plugin download location
 
-All the Lovelace Plugins you download with HACS is stored in `www/community/` in your Home Assistant configuration directory.
+Any Lovelace Plugin you download with HACS is stored in `www/community/` in your Home Assistant configuration directory.
 
 
 ## Special notes about downloaded Lovelace Plugins
 
-When a `.js` file is downloaded, a compressed `.gz` version of if will be created, this file (if it exist) will be served to the requester to save transfer size/time.
+When a `.js` file is downloaded, a compressed `.gz` version of it will be created. This file (assuming it exists) will be served to the requester to save transfer size/time.
 
 If you make local changes to a plugin in the `.js` file, delete the `.gz` variant to have HACS serve up that one.
 
@@ -21,20 +21,18 @@ At the bottom of every page for plugins it will state how you should add it to y
 
 ### Custom view (/community_plugin)
 
-HACS have a custom view/path/endpoint for serving up Lovelace elements (plugins) `/community_plugin/`, this works mostly the same way as `/local` but have some extra features.
+HACS has a custom view/path/endpoint for serving up Lovelace elements (plugins) `/community_plugin/`, this works mostly the same way as `/local` but has some extra features.
 
-- The `/community_plugin` endpoint does not have cache issues, it will instruct your browser to fetch a new version on each load.
+- The `/community_plugin` endpoint does not cache anything; it will instruct your browser to fetch a new version on each load.
 - The `/community_plugin` endpoint will try to serve a .gz variant of the element, this will make the element smaller and the transfer will be faster.
 
 Examples:
 
-Your plugin exist in `www/community/plugin/plugin.js` you can use both `/local/community/plugin/plugin.js` and `/community_plugin/plugin/plugin.js` to reference it, but only the `community_plugin` version will have the extra features that HACS offers.
+Your plugin exists in `www/community/plugin/plugin.js` you can use both `/local/community/plugin/plugin.js` and `/community_plugin/plugin/plugin.js` to reference it, but only the `community_plugin` version will have the extra features that HACS offers.
 
-`.gz` example, CCH (Compact Custom Header) is a fairly popular element for Lovelace, when you use `/local` you will transfer the `.js` file with it's 101kB, if you use HACS and `/community_plugin` for it, it will give you the `.gz` version atuomagically and that is only at 20kB (sizes was for version 1.4.7 of CCH).
+`.gz` example: CCH (Compact Custom Header) is a fairly popular element for Lovelace. When you use `/local` you will transfer the `.js` file which is 101kB, but if you use HACS and reference the plugin with `/community_plugin`, it will serve the 20kB `.gz` version automagically (sizes accurate for version 1.4.7 of CCH).
 
 ### Open plugin button
 
-Every plugin you have installed with HACS will have a "Open pluign" button.
-This is useful to use while troubleshooting, if you can see a code wall everything is OK.
-
-if you get a 404 try reinstalling it.
+Every plugin you have installed with HACS will have a "Open plugin" button.
+This is useful when troubleshooting; if you can see a code wall (the underlying `.js` file) everything is OK, but if you get a 404 try reinstalling it.
diff --git a/documentation/categories/python_scripts.md b/documentation/categories/python_scripts.md
@@ -5,7 +5,7 @@ title: Python Scripts
 
 Python Scripts is a part of the Home Assistant [`python_script` integration.](https://www.home-assistant.io/integrations/python_script/)
 
-Python Scripts is **not** enabled by default in HACS, the reason for that is that it is not enabled by default in Home Assistant.
+Python Scripts is **not** enabled by default in HACS (this follows default Home Assistant behavior).
 
 ## Enable Python Scripts in HACS
 
@@ -17,21 +17,21 @@ Add a checkmark to the left of python_scripts in the UI configuration for HACS.
 
 ![configuration](/img/conf4.png)
 
-[For more about configure HACS with the UI have a look here](configuration/basic.md)
+[For more about configuring HACS with the UI have a look here](configuration/basic.md)
 
-### Enable if you used the YAML to configure HACS
+### Enable if you used YAML to configure HACS
 
-If you used YAML to configure HACS, add this under your HACS connfiguration to enable Python Scripts.
+If you used YAML to configure HACS, add this under your HACS configuration to enable Python Scripts:
 
 ```yaml
 hacs:
   ...
   python_script: true
 ```
 
-When you have done that you need to restart Home Assistant.
+After adding that you need to restart Home Assistant.
 
-[For more about configure HACS with YAML have a look here](configuration/legacy.md)
+[For more about configuring HACS with YAML have a look here](configuration/legacy.md)
 
 ## Python Scripts in Home Assistant
 
@@ -43,4 +43,4 @@ python_script:
 
 ## Python Scripts download location
 
-All the Python Scripts you download with HACS is stored in `python_scripts/` in your Home Assistant configuration directory.
+Any Python Script downloaded with HACS is stored in `python_scripts/` in your Home Assistant configuration directory.
diff --git a/documentation/categories/themes.md b/documentation/categories/themes.md
@@ -5,7 +5,7 @@ title: Themes
 
 Themes is a part of the Home Assistant [`frontend` integration.](https://www.home-assistant.io/integrations/frontend/)
 
-Themes is **not** enabled by default in HACS, the reason for that is that it is not enabled by default in Home Assistant.
+Themes is **not** enabled by default in HACS (this follows default Home Assistant behavior)..
 
 ## Enable themes in HACS
 
@@ -17,21 +17,21 @@ Add a checkmark to the left of themes in the UI configuration for HACS.
 
 ![configuration](/img/conf4.png)
 
-[For more about configure HACS with the UI have a look here](configuration/basic.md)
+[For more about configuring HACS with the UI have a look here](configuration/basic.md)
 
-### Enable if you used the YAML to configure HACS
+### Enable if you used YAML to configure HACS
 
-If you used YAML to configure HACS, add this under your HACS connfiguration to enable themes.
+If you used YAML to configure HACS, add this under your HACS configuration to enable themes:
 
 ```yaml
 hacs:
   ...
   theme: true
 ```
 
-When you have done that you need to restart Home Assistant.
+After adding that you need to restart Home Assistant.
 
-[For more about configure HACS with YAML have a look here](configuration/legacy.md)
+[For more about configuring HACS with YAML have a look here](configuration/legacy.md)
 
 ## Enable themes in Home Assistant
 
@@ -44,4 +44,4 @@ frontend:
 
 ## Themes download location
 
-All the themes you download with HACS is stored in `themes/` in your Home Assistant configuration directory.
+Any theme downloaded with HACS is stored in `themes/` in your Home Assistant configuration directory.
diff --git a/documentation/navigation/installed.md b/documentation/navigation/installed.md
@@ -16,4 +16,4 @@ 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.
+If you hover over the icon you will also see a short description.
diff --git a/documentation/navigation/overview.md b/documentation/navigation/overview.md
@@ -7,11 +7,11 @@ 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:
+Every tab you see here serves a separate 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).
+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
@@ -5,14 +5,14 @@ title: Repository
 
 ![nav_repository](/img/nav_repository.png)
 
-This section has two parts Core and Additional
+This section has two parts: Core and Additional
 
 ## Core
 
 This part give you core information about the repository:
 
 - Title
-- Desctiption
+- Description
 - Installed version
 - Available version(s)
 - Author(s)
@@ -28,13 +28,13 @@ 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.
+Flag this | This will take you to an 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.
+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)
@@ -45,4 +45,4 @@ Uninstall | This will stop tracking versions in HACS, and delete the files that
 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.
+If the repository is a plugin you will also get instructions on how to add it to your Lovelace configuration.