Documentation

This repository contains all the code for our online product documentation at docs.FutureProofHomes.net.
Explore the docs »

View Main Website · Watch Our YouTube

Table of Contents

1. About The Documentation
   • Built With
2. Contributing
3. License
4. Contact

About Documentation

FutureProofHomes focuses on building hardware and software for the Home Assistant platform. We specifically focus on AI-powered voice assistance so that you can control your home with intuitive voice conversations instead of interacting with a user interface.

Built With

• 

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/DocumentationModification)
3. Commit your Changes (git commit -m 'Add some DocumentationModification')
4. Push to the Branch (git push origin feature/DocumentationModification)
5. Open a Pull Request

Local Development Environment

1. Ensure Python and pip are installed on your machine (python --version) and (pip --version)
2. Create a Python Virtual Environment (python -m venv venv)
3. Start the Python Environment (source venv/bin/activate)
4. Install the documentation dependencies (pip install -r requirements.txt)
5. Serve MkDocs locally (mkdocs serve --livereload)

(back to top)

License

Distributed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.txt for more information.

(back to top)

Contact

FutureProofHomes - Website - hello@futureproofhomes.net

(back to top)

Acknowledgments

• @qulbnsl for getting our firmware CI/CD pipelines operational and dynamically updating ESP Web Tools documentation.
• Your name here soon. :)

(back to top)