Remove unnecessary config file for D1 Mini #532
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
klaasnicolaas
added
the
documentation
WalkthroughWalkthroughThe changes involve the removal of the Wemos D1 mini microcontroller option across various documentation files. This alteration is reflected in the README, the Getting Started guide, and the diagram reference file. The focus remains on using either ESP32 or ESP8266 boards, with corresponding updates to pin mappings and connection descriptions. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- Readme.md (2 hunks)
- docs/docs/getting-started.mdx (2 hunks)
- docs/docs/reference/diagram.mdx (1 hunks)
Additional context used
Markdownlint
Readme.md
53-53: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
54-54: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
55-55: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
51-51: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (3)
docs/docs/reference/diagram.mdx (2)
27-32: LGTM! Wemos D1 mini removed from Photodiode GPIO pin table.The removal of the Wemos D1 mini from the GPIO pin table for the Photodiode is consistent and correct.
38-43: LGTM! Wemos D1 mini removed from Status LED GPIO pin table.The removal of the Wemos D1 mini from the GPIO pin table for the Status LED is consistent and correct.
docs/docs/getting-started.mdx (1)
28-28: LGTM! Wemos D1 mini removed from hardware section.The removal of the Wemos D1 mini from the list of microcontrollers and their affiliate links is consistent and correct.
| - ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop] | ||
| - ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop] | ||
| - Wemos D1 mini - [AliExpress](https://s.click.aliexpress.com/e/_DFkIzM7) or [Banggood][wemos-d1-bg-shop] or [AliExpress][wemos-d1-ali-shop] | ||
| - Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop] | ||
| - 3D-printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder) | ||
| - LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (please note that you will not receive an LDR) |
There was a problem hiding this comment.
Fix the indentation issues for the list items.
The indentation is inconsistent for list items at the same level.
- - ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop]
- - ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop]
- - Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop]
- - 3D-printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder)
- - LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (please note that you will not receive an LDR)
- - LED RGB 5mm 4 pin - kathode: [AliExpress](https://s.click.aliexpress.com/e/_Dn1D0wT) or [Banggood][rgbled-bg-shop] or [AliExpress][rgbled-ali-shop]
+ - ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop]
+ - ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop]
+ - Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop]
+ - 3D-printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder)
+ - LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (please note that you will not receive an LDR)
+ - LED RGB 5mm 4 pin - kathode: [AliExpress](https://s.click.aliexpress.com/e/_Dn1D0wT) or [Banggood][rgbled-bg-shop] or [AliExpress][rgbled-ali-shop]Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop] | |
| - ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop] | |
| - Wemos D1 mini - [AliExpress](https://s.click.aliexpress.com/e/_DFkIzM7) or [Banggood][wemos-d1-bg-shop] or [AliExpress][wemos-d1-ali-shop] | |
| - Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop] | |
| - 3D-printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder) | |
| - LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (please note that you will not receive an LDR) | |
| - ESP32 (recommended) - [AliExpress](https://s.click.aliexpress.com/e/_DdAe4Fl) or [Banggood][esp32-bg-shop] or [AliExpress][esp32-ali-shop] | |
| - ESP8266 - [AliExpress](https://s.click.aliexpress.com/e/_DCd13n1) or [Banggood][esp8266-bg-shop] or [AliExpress][esp8266-ali-shop] | |
| - Dupont Jumpers (female to male) - [AliExpress](https://s.click.aliexpress.com/e/_DmbrJsj) or [Banggood][dupont-jumpers-shop] | |
| - 3D-printed case (see the [case](https://glow-energy.io/docs/reference/cases) folder) | |
| - LM393 Photodiode: [AliExpress](https://s.click.aliexpress.com/e/_DDkX3zN) or [Banggood][photodiode-bg-shop] or [AliExpress][photodiode-ali-shop] (please note that you will not receive an LDR) |
Tools
Markdownlint
53-53: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
54-54: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
55-55: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level(MD005, list-indent)
51-51: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
* Fix code in docs showing the !extend way (#520) * Remove unnecessary if condition in deploy workflow (#521) * ⬆️ Update esphome/build-action action to v3.2.0 (#523) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Use project.version for combine manifest build (#524) * Add check for firmware update button (#525) * Remove unnecessary button component code * ⬆️ Update actions/download-artifact action to v4.1.8 (#529) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/upload-artifact action to v4.3.4 (#530) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Remove unnecessary config file for D1 Mini (#532) * Remove unnecessary config file for D1 Mini * Remove Wemos D1 Mini from the docs * ⬆️ Lock file maintenance (#531) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update dependency @easyops-cn/docusaurus-search-local to v0.44.3 (#534) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update actions/setup-node action to v4.0.3 (#535) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Add note about GPIO pin variations in wiring diagram (#537) * ⬆️ Lock file maintenance * Change if condition for building docs (#541) * Change if condition for building docs * Small change on if statement * Add optional hardware to use for prototyping (#542) * ⬆️ Update dependency @fortawesome/free-solid-svg-icons to v6.6.0 (#545) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update dependency @fortawesome/free-brands-svg-icons to v6.6.0 (#544) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * ⬆️ Update dependency @fortawesome/fontawesome-svg-core to v6.6.0 (#543) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Bump Home Assistant Glow to v4.1.1 * Fix typo in docs --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This fixes a bug where a regular ESP8266 board always installs the software that was actually intended for the Wemos D1 Mini.
Related to: #528
Summary by CodeRabbit