Skip to content

docs: external-reader pass — mermaid diagrams, real onboarding flow, security mode#1

Merged
cnewkirk merged 1 commit into
mainfrom
worktree-docs-friendly-pass
Jul 4, 2026
Merged

docs: external-reader pass — mermaid diagrams, real onboarding flow, security mode#1
cnewkirk merged 1 commit into
mainfrom
worktree-docs-friendly-pass

Conversation

@cnewkirk

@cnewkirk cnewkirk commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Reader-facing pass over the hueman docs:

  • README: leads as hueman with a naming note for the hue-iac CLI; two mermaid diagrams (data-flow + a-day-under-hueman timeline, both validated); inventory and security join the command list; first-time setup now copies examples/home.yaml and uses inventory to map your real lights (previously it told you to apply the fictional example); new hardware-requirements section (what needs Bridge Pro vs any v2 bridge); module map collapsed into a contributors-only <details>; MIT license section; stale test count fixed.
  • examples/home.yaml: header teaches the copy-and-edit flow.
  • Runbook: de-personalized ("the Mac" → your dev machine, etc.).

Deny-list still CLEAN; 307 tests pass; example config validates.

🤖 Generated with Claude Code

…security mode

README: repo/CLI naming note, architecture + day-timeline mermaid diagrams
(GitHub renders these natively), commands gain inventory + security, setup
flow now copies the example and uses inventory to map YOUR lights instead
of applying the fictional example, hardware-requirements section, module
map folded into a contributors details block, MIT license section, test
count unstale. Example config header teaches the copy-and-edit flow.
Runbook loses the last homelab phrasings (the Mac, apartment).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@cnewkirk
cnewkirk merged commit b44b3f1 into main Jul 4, 2026
1 check passed
@cnewkirk
cnewkirk deleted the worktree-docs-friendly-pass branch July 4, 2026 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant