jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Add blog post about documentation

Browse source
This commit is contained in:
Paulus Schoutsen 2016-04-17 00:06:41 -07:00
parent d8c8cf4c8d
commit ea81254ba1
6 changed files with 48 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
source/_posts/2016-04-17-updated-documentation.markdown Normal file
View file

@ -0,0 +1,26 @@
---
layout: post
title: "Updated documentation"
description: "We have reorganised our documentation which should make it easier to get started and develop for Home Assistant."
date: 2016-04-16 23:09:00 -0700
date_formatted: "April 17, 2016"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Website
---
One of the main complaints that we receive is something along the lines "I read that X is possible yet I am unable to find it on the website.". This post is to announce that we have taken the first steps to improve it by revamping the [getting started] and [developers] sections. It's still a work in progress but we now have a solid foundation to build on for the future 👍.
Our documentation has been going through various phases. Initially it was just the README in our GitHub repository. I discovered Jekyll and GitHub pages in December 2014 and created home-assistant.io. I more or less broke the README in 5 pages and [called it a website]. Back then we had a whopping [11 components](https://github.com/home-assistant/home-assistant.io/blob/86bb2df430ce267ab2123d51592d3f068ae509b5/source/components/index.markdown).
As Home Assistant grew, so did our documentation. [Fabian Affolter](https://github.com/fabaff) does an amazing job in making sure there is at least a documentation stub for each new feature that lands. And that's quite a feat given our [frequent releases](https://home-assistant.io/blog/categories/release-notes/)! But despite all the efforts, the documentation outgrew our existing documentation organisation.
Today it has been almost 1.5 years since we started the website. We now have [264 components and platforms] under our belt and have been honored with 1.5 million pageviews ✨. And hopefully we now also have documentation that our community deserves.
[getting started]: /getting-started/
[developers]: /developers/
[called it a website]: /blog/2014/12/18/website-launched/
[264 components and platforms]: /components/
Finally, if you see some content that could use more clarifcation or is outdated, don't hesitate to use the 'Edit in GitHub' link that is present on each page.