It is easy to help keep our documentation up to date and it is a simple way you can contribute to the Home Assistant project.
First go to https://github.com/ and sign up for an account. Its quick free and easy. Sign up and sign in.
At the bottom of every documentation page there is an Edit button for you to click.
When you click that link you will be brought to a new page with contents of the page you wanted to edit. In the upper right there is a pencil icon, click it to edit the page.
On the resulting page you can edit the text. Use the existing content and reference the existing page for figuring out how to edit the content. Usually the page just needs some tweaking so you don’t need to start over, just add on or delete some text.
If you are making a large change/new page be sure to read the documentation standards before getting started. See: Standards | Home Assistant Developer Docs
When you are done, click the green Commit changes button.
Then fill in some detail about your change in the pop-up window and click the green Propose changes button
On the next page, click the green Create Pull Request button
On the next page add any additional comments and fill out the two checklists. Then click green Create Pull Request button.
You’re Done! You just submitted your first pull request and contributed to improving Home Assistant!
If this is your first time submitting you likely will need to sign the CLA. This is easy to do and you will either brought straight to it or receive an e-mail to complete this step. Its as simple as reading and clicking another box.
From here you will get an e-mail stating that your pull request was submitted and it will identify some reviewers based on who has worked on the page in the past. You will continue to get e-mails with updates on the status as needed. Eventually you will get one that it has been merged and your changes will go live sometime after.
If all of this seems too much then click the feedback link at the bottom of the documentation page instead and provide details of what you think needs fixing.
You will need a github account for this too (see top of this guide).
Wouldn’t adding this to the documentation be roughly the same process?
)
