diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 57523f8..4277da4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,7 +2,7 @@ name: Publish docs to GitHub Pages on: push: branches: - - add-diy4_2-sensors-and-capabilities + - main jobs: build: diff --git a/README.md b/README.md index c96f0cd..fb32489 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is an Arduino software implementation for the AirGradient DIY Air Quality Sensor Pro, PCB version 4.2. I have paused development for this project. -I created this fork of [AirGradient's Arduino code](https://github.com/airgradienthq/arduino) prior to their implementation of MQTT and local web server support. My intention was to add that functionality while also bringing in other software development best practices such as automated testing and Continuous Integration and patterns like SOLID. [Click here for detailed documentation about the implementation](https://ericlauber.github.io/airgradient_mqtt/). +I created this fork of [AirGradient's Arduino code](https://github.com/airgradienthq/arduino) prior to their implementation of MQTT and local web server support. My intention was to add that functionality while also bringing in other software development best practices such as automated testing and Continuous Integration and patterns like SOLID. [Click here for detailed documentation about the implementation](https://ericlauber.github.io/airgradient_with_tests/). Please feel free to use this project as an example of applying modern software development best practices to Arduino projects. diff --git a/docs/implementation/networking.md b/docs/implementation/networking.md index 2d710ed..f6a8673 100644 --- a/docs/implementation/networking.md +++ b/docs/implementation/networking.md @@ -6,4 +6,4 @@ Todo: - networking dependency injection - MQTT -- HTTP Verbs \ No newline at end of file +- HTTP Verbs diff --git a/docs/index.md b/docs/index.md index 2345160..13653bb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ This is an Arduino software implementation for the AirGradient DIY Air Quality Sensor Pro, PCB version 4.2. I have paused development for this project. -I created this fork of [AirGradient's Arduino code](https://github.com/airgradienthq/arduino) prior to their implementation of MQTT and local web server support. My intention was to add that functionality while also bringing in other software development best practices such as automated testing and Continuous Integration and patterns like SOLID. [Click here for detailed documentation about the implementation](https://ericlauber.github.io/airgradient_mqtt/). +I created this fork of [AirGradient's Arduino code](https://github.com/airgradienthq/arduino) prior to their implementation of MQTT and local web server support. My intention was to add that functionality while also bringing in other software development best practices such as automated testing and Continuous Integration and patterns like SOLID. The previous base configuration for an AirGradient product is for it to log data to AirGradient's servers. This sketch augments that functionality with MQTT capabilities to log data to a server of your choice. diff --git a/mkdocs.yml b/mkdocs.yml index abd3a28..849da12 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,13 +1,13 @@ # Project information site_name: AirGradient Arduino MQTT -site_url: https://ericlauber.github.io/airgradient_mqtt/ +site_url: https://ericlauber.github.io/airgradient_with_tests/ site_author: Eric Lauber site_description: >- Arduino sketch for AirGradient DIY PRO V4.2 with added MQTT support, based around an ESP8266 Microcontroller. # Repository -repo_name: EricLauber/airgradient_mqtt -repo_url: https://github.com/EricLauber/airgradient_mqtt +repo_name: EricLauber/airgradient_with_tests +repo_url: https://github.com/EricLauber/airgradient_with_tests # Configuration theme: