Skip to content

Re-organisation Documentation and Getting started #2055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 51 commits into from
Feb 23, 2017
Merged

Re-organisation Documentation and Getting started #2055

merged 51 commits into from
Feb 23, 2017

Conversation

fabaff
Copy link
Member

@fabaff fabaff commented Feb 16, 2017

Description:

This the re-organization of the Home Assistant documentation as proposed in #1603.

  • The "Getting started" steps are now again in a kind of wizard-style. Extremely minimalist and reduced to fit on a single screen with no scrolling needed to see the whole page.
  • New "Docs" section which contains the information previously available in "Getting started"
  • Ecosystem, Details, and the advanced topics are now part of "Docs"
  • To make the maintenance easier, are now all files divided in a folder per topic in "Docs".
  • MQTT splitted like Z-Wave and moved to "Docs"
  • and everything else which I already forgot over the 30 commits

Todo:

  • Rename section/titles in "Docs" if the name is not accurate enough
  • Review the page if the previously used navigation link at the end of the pages is gone
  • Check all links Fixing broken links #2217 😞
  • Create a better layout of the "Docs" (see Clean up getting started #1603 for navigation examples)

We need to discuss the handling of the HTTP 404 messages. This PR will break almost all links to the documentation. We introduced redirect_from: a while back and could use it. Any thoughts?

@balloob balloob mentioned this pull request Feb 16, 2017
9 tasks
@fabaff fabaff mentioned this pull request Feb 16, 2017
@fabaff fabaff changed the title Re organisation Re-organisation Documentation and Getting started Feb 16, 2017
@fabaff fabaff mentioned this pull request Feb 16, 2017
@fabaff
Copy link
Member Author

fabaff commented Feb 23, 2017

I made the changes according the gitter conversation a couple of days back. The "Getting started" section was updated, redirects added, and we no longer use collections.

I will merge this as there are no more comments at the moment to address.

@fabaff fabaff merged commit 4813201 into home-assistant:current Feb 23, 2017
@wroadd
Copy link
Contributor

wroadd commented Feb 23, 2017

"Getting Started" section Index page contains wrong links on the live page, the "next" branch contains the correct one.

@fabaff fabaff deleted the re-organisation branch February 23, 2017 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants