From b7e4a46476c93c325bddafbe61d8011918cdcd14 Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Sun, 17 Dec 2023 17:57:12 +0100 Subject: [PATCH] Move en-docs to docs folder --- README.md | 10 +++++----- ReleaseNotes.md | 4 ++-- docs/{en => }/README.md | 0 docs/{en => }/addon_climate.md | 0 docs/{en => }/alarm.md | 0 docs/{en => }/blueprint.md | 10 +++++----- docs/{en => }/customization.md | 0 docs/{en => }/error_initializing.md | 4 ++-- docs/{en => }/howto.md | 0 docs/{en => }/install.md | 0 docs/{en => }/lovelace_ui.md | 0 docs/{en => }/nspanel_blank.md | 0 docs/{en => }/tft_upload.md | 0 docs/{en => }/weather.md | 0 14 files changed, 14 insertions(+), 14 deletions(-) rename docs/{en => }/README.md (100%) rename docs/{en => }/addon_climate.md (100%) rename docs/{en => }/alarm.md (100%) rename docs/{en => }/blueprint.md (97%) rename docs/{en => }/customization.md (100%) rename docs/{en => }/error_initializing.md (97%) rename docs/{en => }/howto.md (100%) rename docs/{en => }/install.md (100%) rename docs/{en => }/lovelace_ui.md (100%) rename docs/{en => }/nspanel_blank.md (100%) rename docs/{en => }/tft_upload.md (100%) rename docs/{en => }/weather.md (100%) diff --git a/README.md b/README.md index 26de96c..9cc3257 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,9 @@ This innovative solution is designed to revolutionize how you interact with your ## 📚 Documentation & Resources -- **Getting Started:** Dive into our comprehensive [Documentation and Setup Guide](/docs/en/README.md) for detailed instructions. -- **Video Tutorial:** Prefer visual learning? Check out our [Step-by-Step Setup Video](/docs/en/README.md). -- **Troubleshooting:** Encounter an issue? Here's how to report it: [WIKI HowTo](/docs/en/README.md). +- **Getting Started:** Dive into our comprehensive [Documentation and Setup Guide](docs/README.md) for detailed instructions. +- **Video Tutorial:** Prefer visual learning? Check out our [Step-by-Step Setup Video](docs/README.md). +- **Troubleshooting:** Encounter an issue? Here's how to report it: [WIKI HowTo](docs/README.md). - **Feature Requests:** Got ideas? Share them [here](/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request). - **What's Next?:** Discover what's next and what we are working on right now in our [Milestones](https://github.com/Blackymas/NSPanel_HA_Blueprint/milestones?direction=asc&sort=due_date) @@ -43,7 +43,7 @@ This innovative solution is designed to revolutionize how you interact with your - Buttons show current brightness and cover position in the button itself - Buttons label can be assigned via blueprint - Weather + 5 days weather forecast -- Thermostat + Touch + [Relay control for floor heating](/docs/en/addon_climate.md) +- Thermostat + Touch + [Relay control for floor heating](docs/addon_climate.md) - Light control (brightness, color and temperature) - via long Press - Cover control (open, close and position) - via long press - Settings page (display brightness, display dim brightness, sleep mode, reboot NSPanel) @@ -116,7 +116,7 @@ This innovative solution is designed to revolutionize how you interact with your - 4 user's selectable values (for water and external temperatures, etc.) - All the standard climate controls from Home Assistant (`heat`, `fan`, `cool`, `auto`, `dry`) - 2 user's selectable buttons -- [Can be used for local control (even when Wi-Fi is unavailable) when your panel's relays are used to control your cooler/heater](/docs/en/addon_climate.md) +- [Can be used for local control (even when Wi-Fi is unavailable) when your panel's relays are used to control your cooler/heater](docs/addon_climate.md)   ### Fan speed diff --git a/ReleaseNotes.md b/ReleaseNotes.md index b5a302a..a79d1eb 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -104,8 +104,8 @@ If an invalid value is entered or this substitution is not present, the current The system will always fall back to the standard baud rate (115200 bps) if other tentatives fails.   -## Next topics we are currently working on -See here: https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap +## What's Next? +Discover what's next and what we are working on right now in our [Milestones](https://github.com/Blackymas/NSPanel_HA_Blueprint/milestones?direction=asc&sort=due_date)   ## Special thanks to: diff --git a/docs/en/README.md b/docs/README.md similarity index 100% rename from docs/en/README.md rename to docs/README.md diff --git a/docs/en/addon_climate.md b/docs/addon_climate.md similarity index 100% rename from docs/en/addon_climate.md rename to docs/addon_climate.md diff --git a/docs/en/alarm.md b/docs/alarm.md similarity index 100% rename from docs/en/alarm.md rename to docs/alarm.md diff --git a/docs/en/blueprint.md b/docs/blueprint.md similarity index 97% rename from docs/en/blueprint.md rename to docs/blueprint.md index 8af4003..1981ede 100644 --- a/docs/en/blueprint.md +++ b/docs/blueprint.md @@ -168,8 +168,8 @@ Of course there is also the possibility to enter a label for each of the 4 pages # Example Screenshots -![Blueprint 01](/docs/pics/ha_blueprint_01.png) -![Blueprint 02](/docs/pics/ha_blueprint_02.png) -![Blueprint 03](/docs/pics/ha_blueprint_03.png) -![Blueprint 04](/docs/pics/ha_blueprint_04.png) -![Blueprint 05](/docs/pics/ha_blueprint_05.png) +![Blueprint 01](pics/ha_blueprint_01.png) +![Blueprint 02](pics/ha_blueprint_02.png) +![Blueprint 03](pics/ha_blueprint_03.png) +![Blueprint 04](pics/ha_blueprint_04.png) +![Blueprint 05](pics/ha_blueprint_05.png) diff --git a/docs/en/customization.md b/docs/customization.md similarity index 100% rename from docs/en/customization.md rename to docs/customization.md diff --git a/docs/en/error_initializing.md b/docs/error_initializing.md similarity index 97% rename from docs/en/error_initializing.md rename to docs/error_initializing.md index db66346..791891b 100644 --- a/docs/en/error_initializing.md +++ b/docs/error_initializing.md @@ -9,9 +9,9 @@ Understanding what is shown on the boot page can be useful to find the cause of ## Understanding the boot page Your boot page probably looks like this: #### Before ESPHome is connected: -![Boot page Initializing](/docs/pics/eu_boot_initializing.png) +![Boot page Initializing](pics/eu_boot_initializing.png) #### When ESPHome is connected: -![Boot page with IP](/docs/pics/eu_boot_with_ip_address.png) +![Boot page with IP](pics/eu_boot_with_ip_address.png) ### What is shown on the screen #### Initializing or IP address diff --git a/docs/en/howto.md b/docs/howto.md similarity index 100% rename from docs/en/howto.md rename to docs/howto.md diff --git a/docs/en/install.md b/docs/install.md similarity index 100% rename from docs/en/install.md rename to docs/install.md diff --git a/docs/en/lovelace_ui.md b/docs/lovelace_ui.md similarity index 100% rename from docs/en/lovelace_ui.md rename to docs/lovelace_ui.md diff --git a/docs/en/nspanel_blank.md b/docs/nspanel_blank.md similarity index 100% rename from docs/en/nspanel_blank.md rename to docs/nspanel_blank.md diff --git a/docs/en/tft_upload.md b/docs/tft_upload.md similarity index 100% rename from docs/en/tft_upload.md rename to docs/tft_upload.md diff --git a/docs/en/weather.md b/docs/weather.md similarity index 100% rename from docs/en/weather.md rename to docs/weather.md