Refactor Documentation (#4)

* Added foldouts for use cases * Added foldouts for use cases * Cleanup * Cleanup * Added 2 adopter section frameworks * lint * Fixes * Fixes to Yaml. needs fixes to toggle blocks * Fixed toggle blocks by splitting out to new files * App Screenshots redo * Fixes for linter * More lint fixes * Linter fixes * Fix quick-start guide * Cleanup, New videos, Format fixes * videos added and linted * More linting * Revert whitespace changes * Revert more whitespaces * Revert even more whitespaces --------- Co-authored-by: Daniel Mohns <[email protected]>
EnAccess · Oct 30, 2023 · 85b23a8 · 85b23a8
1 parent 9f8a2ef
commit 85b23a8
Show file tree

Hide file tree

Showing 109 changed files with 483 additions and 1,103 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -20,7 +20,7 @@ pipx inject mkdocs mkdocs-material
 mkdocs serve
 ```
 
-Then open [docs](http://127.0.0.1:8000/OpenSmartMeter/) in a local web browser.
+Then open [docs](http://127.0.0.1:8000/AirLink-Docs/) in a local web browser.
 
 ## Writing documentation
 

diff --git a/docs/AirLink App.md b/docs/AirLink App.md
diff --git a/docs/AirLink App/1._Devices_view.jpg b/docs/AirLink App/1._Devices_view.jpg
diff --git a/docs/AirLink App/2.10_SUCCESS_-_Success_on_syncing_data.jpg b/docs/AirLink App/2.10_SUCCESS_-_Success_on_syncing_data.jpg
diff --git a/docs/AirLink App/2.1_READ_RESOURCE_-_Data_is_empty.jpg b/docs/AirLink App/2.1_READ_RESOURCE_-_Data_is_empty.jpg
diff --git a/docs/AirLink App/2.2_AUTHORIZE_-_Device_authorized.jpg b/docs/AirLink App/2.2_AUTHORIZE_-_Device_authorized.jpg
diff --git a/docs/AirLink App/2.3_READ_RESOURCE_-_Data_is_displayed.jpg b/docs/AirLink App/2.3_READ_RESOURCE_-_Data_is_displayed.jpg
diff --git a/docs/AirLink App/2.4_PROVISION_-_Choice_for_serialization.jpg b/docs/AirLink App/2.4_PROVISION_-_Choice_for_serialization.jpg
diff --git a/docs/AirLink App/2.5_TYPE_SERIAL_NUMBER.jpg b/docs/AirLink App/2.5_TYPE_SERIAL_NUMBER.jpg
diff --git a/docs/AirLink App/2.6_Device_provisioned_successfully.jpg b/docs/AirLink App/2.6_Device_provisioned_successfully.jpg
diff --git a/docs/AirLink App/2.7_ENTER_PAYG_TOKEN.jpg b/docs/AirLink App/2.7_ENTER_PAYG_TOKEN.jpg
diff --git a/docs/AirLink App/2.8_SUCCESS_-_Success_on_Token_entry.jpg b/docs/AirLink App/2.8_SUCCESS_-_Success_on_Token_entry.jpg
diff --git a/docs/AirLink App/2.9_SYNC_-_Syncing_data.jpg b/docs/AirLink App/2.9_SYNC_-_Syncing_data.jpg
diff --git a/docs/AirLink App/2._Resources_view.jpg b/docs/AirLink App/2._Resources_view.jpg
diff --git a/docs/AirLink App/3.1_PROVISION_GATEWAY_-_Gateway_provisioned_successfully.jpg b/docs/AirLink App/3.1_PROVISION_GATEWAY_-_Gateway_provisioned_successfully.jpg
diff --git a/docs/AirLink App/3._Profile_view.jpg b/docs/AirLink App/3._Profile_view.jpg
diff --git a/docs/AirLink App/AirLink_BLE_Simulator.jpg b/docs/AirLink App/AirLink_BLE_Simulator.jpg
diff --git a/docs/AirLink App/AirLink_Data_Flow.png b/docs/AirLink App/AirLink_Data_Flow.png
diff --git a/docs/AirLink App/MVVMPattern.png b/docs/AirLink App/MVVMPattern.png
diff --git a/...Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae.md b/...Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae.md
diff --git a/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.52.11_AM.png b/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.52.11_AM.png
diff --git a/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.52.50_AM.png b/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.52.50_AM.png
diff --git a/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.53.38_AM.png b/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.53.38_AM.png
diff --git a/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.53.55_AM.png b/...tion 1c38135f4b6b4e3db7ed0d2b3a30ccae/Screen_Shot_2021-10-04_at_10.53.55_AM.png
diff --git a/docs/AirLink App/home - credentials page - airlink.jpg b/docs/AirLink App/home - credentials page - airlink.jpg
diff --git a/docs/AirLink App/home - credentials page - angaza.jpg b/docs/AirLink App/home - credentials page - angaza.jpg
diff --git a/...nk App/home - device list page - device details page - provisioning choices.jpg b/...nk App/home - device list page - device details page - provisioning choices.jpg
diff --git a/...ice list page - device details page - provisioning input with type expanded.jpg b/...ice list page - device details page - provisioning input with type expanded.jpg
diff --git a/...Link App/home - device list page - device details page - provisioning input.jpg b/...Link App/home - device list page - device details page - provisioning input.jpg
diff --git a/...ink App/home - device list page - device details page - transfer payg token.jpg b/...ink App/home - device list page - device details page - transfer payg token.jpg
diff --git a/docs/AirLink App/home - device list page - device details page.jpg b/docs/AirLink App/home - device list page - device details page.jpg
diff --git a/docs/AirLink App/home - device list page - no permissions.jpg b/docs/AirLink App/home - device list page - no permissions.jpg
diff --git a/docs/AirLink App/home - device list page.jpg b/docs/AirLink App/home - device list page.jpg
diff --git a/docs/AirLink App/home - payg token page - enter credit.jpg b/docs/AirLink App/home - payg token page - enter credit.jpg
diff --git a/docs/AirLink App/home - payg token page - search for device.jpg b/docs/AirLink App/home - payg token page - search for device.jpg
diff --git a/docs/AirLink App/home - payg token page - token generated.jpg b/docs/AirLink App/home - payg token page - token generated.jpg
diff --git a/docs/AirLink App/home - payg token page.jpg b/docs/AirLink App/home - payg token page.jpg
diff --git a/docs/AirLink Devices.md b/docs/AirLink Devices.md
diff --git a/docs/AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0.csv b/docs/AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0.csv
diff --git a/...090ba4475583e05f72cc537ff0/COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76.md b/...090ba4475583e05f72cc537ff0/COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76.md
diff --git a/...d4247090ba4475583e05f72cc537ff0/cbor header d5440a5437974c6e898fad616e623875.md b/...d4247090ba4475583e05f72cc537ff0/cbor header d5440a5437974c6e898fad616e623875.md
diff --git a/docs/AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0_all.csv b/docs/AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0_all.csv
diff --git a/docs/AirLink Devices/Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42.md b/docs/AirLink Devices/Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42.md
diff --git a/docs/AirLink Devices/Range Testing Results.md b/docs/AirLink Devices/Range Testing Results.md
@@ -0,0 +1,13 @@
+# Range Testing Results
+
+Range testing was done with a Laird BL652 (nRF51832) chip in advertisement mode being scanned from an Android phone.
+
+Coverage around concrete house
+![Coverage around concrete house](Range%20Testing%20Results/768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg)
+
+Coverage through concrete walls
+
+![Coverage through concrete walls](Range%20Testing%20Results/0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg)
+
+Line of sight range
+![Line of sight range](Range%20Testing%20Results/20210614_085821_mfnr.jpg)
diff --git a/...0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg → ...0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg b/...0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg → ...0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg
diff --git a/...830d415dc0fa1a42/20210614_085821_mfnr.jpg → ... Testing Results/20210614_085821_mfnr.jpg b/...830d415dc0fa1a42/20210614_085821_mfnr.jpg → ... Testing Results/20210614_085821_mfnr.jpg
diff --git a/...768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg → ...768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg b/...768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg → ...768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg
diff --git a/docs/AirLink Devices/Screenshot_20230208-141454_AirLink_BLE_Simulator.jpg b/docs/AirLink Devices/Screenshot_20230208-141454_AirLink_BLE_Simulator.jpg
diff --git a/docs/AirLink Devices/bluetooth-logo-color-black.svg b/docs/AirLink Devices/bluetooth-logo-color-black.svg
diff --git a/docs/AirLink Devices/bluetooth-logo.png b/docs/AirLink Devices/bluetooth-logo.png