mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-30 13:23:41 +00:00

Julian Pawlowski df79afc87e docs: restructure documentation and add AI development disclosure

Created professional documentation structure:

**User Documentation (docs/user/):**
- README.md: Documentation hub with quick start guide
- Placeholder files for future content migration:
  * installation.md, configuration.md, sensors.md
  * services.md, automation-examples.md, troubleshooting.md

**Developer Documentation (docs/development/):**
- README.md: Comprehensive contributor guide with AI section
- setup.md: DevContainer and environment setup
- architecture.md: Code structure overview
- testing.md: Testing guidelines
- coding-guidelines.md: Style guide and critical patterns
- release-management.md: Complete release workflow documentation

**AI Development Disclosure:**
- README.md: "🤖 Development Note" section before license
  * Honest disclosure about extensive AI assistance
  * Quality assurance measures mentioned
  * Invitation for bug reports with positive tone
- docs/development/README.md: Detailed AI section
  * What AI handles (patterns, generation, refactoring)
  * Benefits (rapid development, consistency)
  * Limitations (edge cases, complex patterns)
  * Quality assurance process
- CONTRIBUTING.md: Brief AI note with practical tip

**Updated:**
- README.md: Simplified to landing page with documentation links
- CONTRIBUTING.md: Modernized with new docs structure
- copilot-instructions.md: Added documentation organization section

Impact: Clear separation of user vs. developer documentation following
open-source best practices. Transparent about AI-assisted development
approach without being defensive. Scalable structure for future growth.

2025-11-09 14:25:27 +00:00

1.1 KiB

Raw Blame History

Development Setup

Note: This guide is under construction. For now, please refer to .github/copilot-instructions.md for detailed setup information.

Prerequisites

VS Code with Dev Container support
Docker installed and running
GitHub account (for Tibber API token)

Quick Setup

# Clone the repository
git clone https://github.com/jpawlowski/hass.tibber_prices.git
cd hass.tibber_prices

# Open in VS Code
code .

# Reopen in DevContainer (VS Code will prompt)
# Or manually: Ctrl+Shift+P → "Dev Containers: Reopen in Container"

Development Environment

The DevContainer includes:

Python 3.13 with .venv at /home/vscode/.venv/
uv package manager (fast, modern Python tooling)
Home Assistant development dependencies
Ruff linter/formatter
Git, GitHub CLI, Node.js, Rust toolchain

Running the Integration

# Start Home Assistant in debug mode
./scripts/develop

Visit http://localhost:8123

Making Changes

# Lint and format code
./scripts/lint

# Check-only (CI mode)
./scripts/lint-check

See .github/copilot-instructions.md for detailed patterns and conventions.

1.1 KiB Raw Blame History