Refined README and config templates

[JanPetterMG]

Improve the readability of the README and add clarifying comments to the config files for better understanding of the configuration options.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 02e39bce-c3c5-420d-9bd4-3f5b1a10ba99

📥 Commits

Reviewing files that changed from the base of the PR and between 6ae5023 and 74fa9fc.

📒 Files selected for processing (2)

• README.md
• include/esp/secrets.h

🚧 Files skipped from review as they are similar to previous changes (2)

• README.md
• include/esp/secrets.h

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details

⏰ Context from checks skipped due to timeout. (3)

• GitHub Check: Build (esp32-c6-zero-b)
• GitHub Check: Tidy (attiny841)
• GitHub Check: Tidy (esp32-c6-zero-b)

---

Summary by CodeRabbit

• Documentation
  • Reorganized and expanded setup guidance covering architecture, offline operation, hardware requirements, installation, wiring, pinouts, status LEDs, and Home Assistant entities.
  • Clarified supported power inputs, signal handling, voltage monitoring, and system component responsibilities.
  • Grouped Home Assistant entities into Controls, Sensors, Configuration, and Diagnostics.
• Configuration
  • Added clearer guidance for Wi-Fi uploads, device host settings, and OTA passwords.
  • Updated default ESP32-C6 pin assignments and documented optional pin configurations for connected hardware.

Walkthrough

The pull request expands Bekant architecture, hardware, wiring, installation, status LED, and Home Assistant documentation. It updates ESP32 pin assignments and adds clearer Wi-Fi, MQTT, OTA, hostname, and PlatformIO configuration comments.

Changes

Bekant documentation and configuration

Layer / File(s)	Summary
Architecture and hardware wiring README.md, include/esp/secrets.h	The README documents architecture, hardware requirements, GPIO connections, voltage domains, open-drain signals, level shifting, and power monitoring. ESP32 default and optional pin assignments are updated.
Installation and device status README.md, platformio.ini	The README clarifies PlatformIO setup, Megadesk flashing order, RGB status LED behavior, and Home Assistant entity categories. The ESP32-C6 configuration documents the commented OTA settings.
Network and OTA configuration include/esp/secrets.h	Configuration comments describe Wi-Fi, MQTT, OTA password, and hostname settings. Configuration values remain unchanged.

Merge Risk: 🔵 Low · up to 74fa9

The configuration updates may document ESP32-C6-Zero pin assignments that conflict with board-reserved functions, which could prevent expected hardware behavior. The change is mergeable with explicit owner awareness and follow-up on those assignments.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the two main change areas: README refinement and configuration template updates.
Description check	✅ Passed	The description accurately summarizes the README readability improvements and added configuration comments.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch Readme-refinements

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6ff37118-3e4f-4cf6-9775-d4590594dfe6

📥 Commits

Reviewing files that changed from the base of the PR and between 4ae2162 and e7af54a.

📒 Files selected for processing (2)

• README.md
• platformio.ini

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Review details

🔇 Additional comments (2)

README.md (1)

3-24: LGTM!

Also applies to: 32-44, 46-65, 108-113, 124-133, 145-162, 164-210

platformio.ini (1)

56-58: LGTM!

[coderabbitai]

Actionable comments posted: 2

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2fcc1eeb-4b31-44a0-b959-62406ee6a533

📥 Commits

Reviewing files that changed from the base of the PR and between e7af54a and 6ae5023.

📒 Files selected for processing (2)

• README.md
• include/esp/secrets.h

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Review details

⏰ Context from checks skipped due to timeout. (2)

• GitHub Check: Build (esp32-c6-zero-b)
• GitHub Check: Tidy (esp32-c6-zero-b)

🔇 Additional comments (1)

include/esp/secrets.h (1)

3-6: LGTM!

Also applies to: 27-29, 40-48