rob
/
home-hub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
home-hub/CLAUDE.md

1.2 KiB
Raw Permalink Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Home Hub - Entertainment system with Home Assistant, smart speakers, and voice control

Development Commands

# Install for development
pip install -e ".[dev]"

# Run tests
pytest

# Run a single test
pytest tests/test_file.py::test_name

Architecture

TODO: Describe the project architecture

Key Modules

TODO: List key modules and their purposes

Key Paths

  • Source code: src/home-hub/
  • Tests: tests/
  • Documentation: docs/ (symlink to project-docs)

Documentation

Documentation lives in docs/ (symlink to centralized docs system).

Before updating docs, read docs/updating-documentation.md for full details on visibility rules and procedures.

Quick reference:

  • Edit files in docs/ folder
  • Use public: true frontmatter for public-facing docs
  • Use <!-- PRIVATE_START --> / <!-- PRIVATE_END --> to hide sections
  • Deploy: ~/PycharmProjects/project-docs/scripts/build-public-docs.sh home-hub --deploy

Do NOT create documentation files directly in this repository.