Skip to content

wiki: add installation guides, reference pages, and console=tty1 requirement - #396

Draft
mreditor97 wants to merge 9 commits into
masterfrom
claude/add-wiki-installation-guides
Draft

wiki: add installation guides, reference pages, and console=tty1 requirement#396
mreditor97 wants to merge 9 commits into
masterfrom
claude/add-wiki-installation-guides

Conversation

@mreditor97

Copy link
Copy Markdown
Owner

Summary

  • Add installation guides for Home Assistant OS, Ubuntu/Linux, Docker, and PyPI
  • Add Enabling-I2C.md reference page covering raspi-config, HAOS (SD card + add-on), and Docker host setup
  • Add Configuration.md full reference covering all config.yaml options, MQTT topics, state payload, and commands
  • Update Home.md with links to all guides and new reference pages
  • Add console=tty1 requirement to the Linux and HAOS guides — required for shutdown/restart commands to work

Test plan

  • Verify all internal wiki links resolve correctly (bare page names, no wiki/ prefix)
  • Confirm console=tty1 steps are clear for both SD card (HAOS) and /boot/firmware/cmdline.txt (Linux) flows
  • Push /home/user/redreactor-wiki to live GitHub Wiki: cd /home/user/redreactor-wiki && git push origin master

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE


Generated by Claude Code

claude added 9 commits May 8, 2026 11:29
Three new wiki pages covering:
- Home Assistant OS: installing via the dedicated HA add-on repository
- Ubuntu/Linux: virtualenv + systemd service with dedicated user and sudoers
- Docker: Dockerfile + docker-compose with I2C device passthrough

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE
- Rename files to match existing wiki page names (Home, Home-Assistant-OS, Linux, Docker)
- Home: fix internal links to use correct wiki page name format
- Home-Assistant-OS: preserve existing I2C setup detail (SD card + add-on methods),
  add prerequisites table and structured steps
- Linux: full rewrite with dedicated user, virtualenv, sudoers, systemd setup
- Docker: full rewrite with Dockerfile, docker-compose, I2C passthrough notes

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE
New PyPI.md covers quick pip install, configuration, running manually,
updating to latest/specific versions, and a pointer to the Linux guide
for setting up as a systemd service.

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE
Docker.md and PyPI.md now reference the Linux guide for I2C setup and
the config reference table instead of repeating them. Removes ~100 lines
of duplicated content across the three installation guides.

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE
These were superseded when wiki files were renamed to match the existing
wiki page names (Docker.md, Home-Assistant-OS.md, Linux.md).

https://claude.ai/code/session_01FP6qFyrYnmARdRoe9QWtRE
- Add wiki/Enabling-I2C.md covering raspi-config, HAOS (SD card + add-on), Docker host
- Add wiki/Configuration.md with full YAML reference, topics, payload, and commands
- Update Linux.md, Docker.md, PyPI.md to link to reference pages instead of embedding content
- Update Home.md with Reference section linking to the two new pages
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.

2 participants