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
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.
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/DocumentationModification) - Commit your Changes (
git commit -m 'Add some DocumentationModification') - Push to the Branch (
git push origin feature/DocumentationModification) - Open a Pull Request
- Ensure Python and pip are installed on your machine (
python --version) and (pip --version) - Create a Python Virtual Environment (
python -m venv venv) - Start the Python Environment (
source venv/bin/activate) - Install the documentation dependencies (
pip install -r requirements.txt) - Serve MkDocs locally (
mkdocs serve --livereload)
Some pages have content that differs between the Stable and Beta firmware. We use content tabs to let viewers toggle between the two. Because content.tabs.link is enabled, selecting "Stable" or "Beta" on any page syncs the choice across the entire site.
For sections that differ between firmware versions, wrap them in content tabs:
=== "Stable"
Stable-specific content here...
=== "Beta"
Beta-specific content here...Pages where content is identical across versions should not use tabs.
When a beta version ships as stable:
- Replace the "Stable" tab content with the "Beta" tab content.
- Remove the tab wrappers (or start a new "Beta" tab for the next cycle).
- Search for any remaining
=== "Beta"/=== "Stable"blocks across all docs to ensure nothing is missed.
Distributed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.txt for more information.
FutureProofHomes - Website - [email protected]
- @qulbnsl for getting our firmware CI/CD pipelines operational and dynamically updating ESP Web Tools documentation.
- Your name here soon. :)