README.md

Battery Energy Trading Documentation

Complete documentation index for the Battery Energy Trading Home Assistant integration.

Quick Start

• Installation Guide - Install via HACS, pip, or manually
• Main README - Project overview, features, and quick start
• Changelog - Version history and release notes

Documentation Sections

📖 User Guide

End-user documentation for installation, configuration, and usage.

User Guide Index

• Installation Guide - HACS, pip, and manual installation
• Automatic Trading Setup - ✨ NEW: Automated setup with generated automations
• Dashboard Setup - Dashboard installation and configuration
• Dashboard Entity Reference - Entity list and descriptions
• Terminology Guide - Understanding slots, hours, and key concepts

🔌 Integration Guides

Documentation for third-party integrations and inverter systems.

Integrations Index

• Sungrow Integration - Sungrow inverter integration guide
• Sungrow Entity Reference - Complete Sungrow entity documentation

🛠️ Development

Documentation for developers and contributors.

Development Index

• Testing Guide - Running tests, coverage, CI/CD
• Manual Testing Checklist - Manual test scenarios
• Features Documentation - Feature details and implementation
• Release Process - Version management and releases
• Development History - Historical implementation logs

🔧 API Reference

Technical API documentation (in development).

API Documentation Index

• Energy Optimizer - Core optimization algorithms (coming soon)
• Sungrow Helper - Auto-detection utilities (coming soon)
• Configuration Flow - Setup wizard (coming soon)
• Entity Platforms - Sensors, binary sensors, numbers, switches (coming soon)

Additional Resources

Project Files

• CLAUDE.md - AI assistant guidelines and architecture documentation
• Documentation Guidelines - Documentation standards and workflow
• LICENSE - MIT License
• Contributing - Contribution guidelines

External Links

• GitHub Repository - Source code and issues
• HACS - Home Assistant Community Store
• Nord Pool Integration - Required dependency
• Sungrow Integration - Optional for auto-detection

Documentation Organization

Directory Structure

docs/
├── README.md                          # This file - main documentation index
├── TERMINOLOGY.md                     # Key concepts and terminology
│
├── user-guide/                        # End-user documentation
│   ├── README.md                      # User guide index
│   ├── automatic-trading-setup.md     # Automatic automation generation (NEW)
│   ├── dashboard-setup.md             # Dashboard setup guide
│   └── dashboard-entity-reference.md  # Dashboard entity list
│
├── integrations/                      # Third-party integration guides
│   ├── README.md                      # Integrations index
│   ├── sungrow.md                     # Sungrow integration guide
│   └── sungrow-reference.md           # Sungrow entity reference
│
├── development/                       # Developer documentation
│   ├── README.md                      # Development index
│   ├── testing.md                     # Testing guide
│   ├── manual-testing-checklist.md    # Manual test scenarios
│   ├── features.md                    # Feature documentation
│   ├── release-process.md             # Release workflow
│   │
│   └── history/                       # Historical documentation
│       ├── README.md                  # History index
│       └── *.md                       # Implementation logs (2025-10)
│
└── api/                               # API documentation (in development)
    └── README.md                      # API index

Navigation Tips

1. Start with the User Guide if you're installing and using the integration
2. Check Integrations for Sungrow or other inverter-specific documentation
3. Visit Development if you're contributing code or running tests
4. Browse History to understand past architectural decisions

Getting Help

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation Bugs: Report via GitHub Issues with documentation label

Documentation Guidelines

See Development Guide for:

• File naming conventions
• When to archive vs keep in main docs
• Cross-reference standards
• Index file requirements