Searchable Home Assistant site

EDIT: Ignore this post and go read the excellent writeup by @silvrr located here

I would suggest just trying it.

I know it looks scary and complicated if you aren’t familiar with Github, but it’s not too bad.

First you need a github account. Once you have that, navigate to a page with errors, and (while logged in) click the “edit this page on github” link. - That will create a fork (a copy) for you, that is located in your own personal github repo. Edit this using the editor built into Github. The directions are on the edit page, and fairly easy to figure out. Once you are happy with it, save the edit (make sure to preview first). After saving, you will have the option to create a PR (a pull request) against the original document you selected to edit. (Remember, up until this point, you have been working on your copy, and not the original!) What this does is takes a copy of your changes, and submits them to the maintainers for a looksie (that’s the technical term). Github will tell you who it thinks should look things over. (In my experience, it is usually @fabaff, @balloob, and/or anyone who had edited that page previously). If everything looks good, your changes will be approved and will become part of the official documentation everyone else depends on.

The main thing to keep in mind here, is that your changes wont go live without someone who knows what they are doing approving them, so don’t worry about messing anything up! Just go forth and edit, and you will get the hang of it!

This is how open source usually works. If everyone contributes, we all become stronger as a result!

Hope that helped,
-Z

1 Like