Skip to content

docs: comprehensive review of all package READMEs - #257

Merged
dannytsang merged 1 commit into
dannytsang:mainfrom
jarvis-tsang:docs/comprehensive-review
Apr 26, 2026
Merged

docs: comprehensive review of all package READMEs#257
dannytsang merged 1 commit into
dannytsang:mainfrom
jarvis-tsang:docs/comprehensive-review

Conversation

@jarvis-tsang

Copy link
Copy Markdown
Collaborator

Reviewed and enhanced all 21 READMEs across integrations and rooms.

Changes

Rewritten (missing content + diagrams added)

  • bedroom3: Added missing automations (blind control, occupancy), full automation table, architecture mermaid
  • front_garden: Added doorbell camera flow, vehicle detection, lock box logic, mermaid diagrams
  • solcast: Added API limit checking logic documentation
  • octopus_energy: Added rate distribution architecture diagram
  • google_travel: Added script documentation

Verified accurate (no changes needed)

  • alarm (enhanced scripts section)
  • energy, hvac, messaging, weather
  • conservatory, kitchen, living_room, office, porch, stairs, bedroom

Stats

Verification

Each README was compared against the actual YAML implementation. All documented entities, automations, and scripts were verified against the source YAML.

Target audience: power users

- bedroom3: Complete rewrite with full automation details, mermaid diagrams
  for blind control logic, entity reference, and cross-references
- front_garden: Complete rewrite with doorbell, camera, vehicle detection,
  lock box, and meter monitoring documented
- solcast: Complete rewrite with 1 automation, API limit checking, and
  entity reference
- octopus_energy: Complete rewrite with rate distribution architecture
  diagram showing all 7 consumer systems
- google_travel: Complete rewrite with calculate_travel script documented
  and template sensors explained
- alarm: Added alarm scripts documentation and improved entity reference
@dannytsang
dannytsang merged commit f573503 into dannytsang:main Apr 26, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants