Repository navigation
docs: split the root README into focused docs - #69
Merged
Merged
Conversation
The root README had grown to 646 lines and carried a lot that belonged
elsewhere: the full Levoit feature matrix, the Levoit component change log, the
Philips CoAP guide, the project change log and the UART-capture how-to. It is
now 139 lines - what the project is, the device tables, and where to go next.
Moved:
- Levoit Features + component change log -> components/levoit/README.md
- Philips/Versuni CoAP guide -> docs/philips-coap.md
- Project change log -> CHANGELOG.md
- UART capture + Logic 2 HLA -> docs/capturing-uart.md
Added:
- CONTRIBUTING.md - the GitHub side: issues, PRs, branch and commit
conventions, what CI runs and how to run it locally, versioning, and the
rule that secrets and EXIF stay out of commits.
- docs/adding-a-new-device.md - the hardware playbook: open the unit and
confirm it is an ESP32-plus-MCU design, find the UART and capture both
directions, decode and build firmware support, pull the original module's
EN pin to GND to park it, wire in your own ESP32, then contribute it back.
Written so the first two steps can be contributed on their own.
The device tables stay in the README - they are the thing people come for -
but the per-component detail behind them now lives with each component.
Relative links in the moved sections were re-rooted for their new depth, and
all cross-file links and anchors verified.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
tuct
added a commit
that referenced
this pull request
Sep 26, 2026
…rrection Review finding: test-all-entities.yaml omitted the light platform, so USE_LEVOIT_LIGHT and the Sprout LED-ring codegen went untested. The generator built the entity list from each platform's TYPE_MAP and light has none - it is a single light_schema entity - so it was skipped silently. Listed explicitly now, with a comment saying why. All nine platforms that define a USE_LEVOIT_* macro are exercised. The changelog correction in this branch targeted the root README, but #69 moved the levoit change log to components/levoit/README.md in the meantime, so the rebase dropped it and the inaccurate claim survived at its new location. Re-applied there. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The root README had grown to 646 lines. It's now 139 — what the project is, the device tables, and where to go next.
Moved out
Features+ component change log (239 lines)components/levoit/README.mddocs/philips-coap.mdCHANGELOG.mddocs/capturing-uart.mdThe device tables stay — they're the thing people come for. What went is the per-component detail sitting behind them, which now lives with each component.
Added
CONTRIBUTING.md— the GitHub side: issues, pull requests, branch and commit conventions, what a good PR includes per change type, what CI runs and how to run it locally, the version/changelog rule, and keeping secrets and EXIF out of commits.docs/adding-a-new-device.md— the hardware playbook:ENpin to GND to park itWritten so steps 1–2 can be contributed on their own — getting to a good labelled dump is the hard part, and the decode can be picked up from there.
Checks
Moving content broke relative links (paths were root-relative), so those were re-rooted for their new depth — 13 links across three files. All cross-file links and anchors verified to resolve.
🤖 Generated with Claude Code