Skip to content

Clean up getting started #1603

Closed
Closed
@balloob

Description

@balloob

Our getting started section has grown over time and the current structure is no longer a getting started guide but more a look at all the stuff you can do.

I think that we have to take a step back and see what is really important. Anything that is not the most important is distracting and should be moved away from the main menu/getting started. It looks too daunting now for new users.

So what is most important? Our Raspberry Pi image. We have 70% of our users using a Pi and that is awesome. I think the last time I checked 80% of them are on a Pi 3 so having it evolve around that will be even better.

So here are some improvements that I can see will improve our guide:

  • Limit getting started to the essentials:
    • Just the RPi image on a Pi 3
    • config 101 (but no advanced stuff like customize)
    • adding your first integrations
    • adding first automation.
  • Create a Docs section and include it in top nav. This is where most of the getting started will move to.
  • Create special UI for docs. Currently our UI is not good for having long nav bars. Something like this and this is beautiful. You can individually scroll the nav from the main content. I can see us having to implement a special layout that doesn't contain the normal header/sidebar just for docs sections.
  • Ecosystem is a great section, but let's move it to the documentation. We should also go through the getting started and find things that we should move to the ecosystem section. Like autostart and Add to Android home screen,
  • "Details" group and "advanced topics" group can stop existing on their own and also move to the docs header.

What do people think of this idea?


Extraction of items/tasks:

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions