jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Standardize the documentation index page (#5427)

Browse Source 
Updates to the [documentation index page](https://www.home-assistant.io/developers/documentation/) to fix some typos & more in line with the [documentation standards](https://www.home-assistant.io/developers/documentation/standards/). 

* Shortcut not *short cut*
* Capitalize Markdown as it's not `markdown`
* When referencing a Pull Request it is always referred to as `Pull Request (PR)`
This commit is contained in:
Brian J King 2018-05-26 02:28:04 -05:00 committed by Fabian Affolter
parent 653d033b0a
commit dbd56999c9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/developers/documentation/index.markdown
View File

@ -12,11 +12,11 @@ redirect_from: /developers/website/
The website you are reading now is the home of Home Assistant: [https://www.home-assistant.io](/). This is the place where we provide documentation and additional details about Home Assistant for end users and developers.
home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll) and [these available dependencies](https://pages.github.com/versions/). The pages are written in [markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know about HTML.
The [home-assistant.io](/) website is built using [Jekyll](http://github.com/mojombo/jekyll) and [these dependencies](https://pages.github.com/versions/). The pages are written in [Markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know about HTML.
You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork. Keep in mind that you can't upload images while working this way.
For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.
For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a Pull Request (PR).
To test your changes locally, you need to install **Ruby** and its dependencies (gems):