-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Clean up getting started #1603
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
Comments
I approve, but I would encourage placing any advanced topic within the docs of the underlying component. This would seriously simplify navigation and I think help other see the big picture. |
I agree with that, I think that breaking component docs into subsections would help tremendously. We already do this for Z-Wave but I feel like MQTT could use that too |
I'd also like to add that platform docs aren't obvious. My thoughts; advertise all the platforms as we kind of do on the components page already, but upon selecting a platform some information/description is displayed before the list of individual components - with a link to further platform documentation. |
Initial thoughts.
Another thought I had was an ask HA blog. Have users ask questions about how to do something and write it up as a blog post. These could be archived as examples of what you can do and how to do it. I'd be happy to help with it. Weekly might be too frequent but monthly should be doable. |
I'd be happy to contribute some of my configs to a config 101 if so desired. Something we find (or I at least) in the "support" chat (to the point that it's become a awful joke) is how to post formatted code snippets (e.g. between 3 backticks). Perhaps it might be worth having a template of sorts (what to include in a help request. not mandatory but recommended) or a primer on some of the eccentricities of markdown. With regards to ui, would having expanding blocks (I think they're called accordions) separating the basic, intermediate, and the what the hell have I just done in the same page but have the upper levels compacted by default. Would it be worth having a FAQ section based on the questions that pop up often either in chat or the forums. Ok, that's enough rambling. Time for bed. |
@bassclarinetl2 currently the configs in the docs are only maintainers, but I can't personally see any problem with adding a community section with links to various GitHubs and a short desc. |
@balloob great ideas, that would make a lot of sense. |
Is this still a valid issue @balloob? |
Last remaining issue splitted out as #3477. |
Uh oh!
There was an error while loading. Please reload this page.
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:
What do people think of this idea?
Extraction of items/tasks:
hass
, scripts, Developer tools, etc Add "Tools and Helper" section #2114The text was updated successfully, but these errors were encountered: