mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 21:33:39 +00:00
df79afc87e
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.
46 lines
2.2 KiB
Markdown
46 lines
2.2 KiB
Markdown
# User Documentation
|
|
|
|
Welcome to Tibber Prices! This integration provides enhanced electricity price data from Tibber with quarter-hourly precision, statistical analysis, and intelligent ratings.
|
|
|
|
## 📚 Documentation
|
|
|
|
- **[Installation](installation.md)** - How to install via HACS and configure the integration
|
|
- **[Configuration](configuration.md)** - Setting up your Tibber API token and price thresholds
|
|
- **[Sensors](sensors.md)** - Available sensors, their states, and attributes
|
|
- **[Services](services.md)** - Custom services and how to use them
|
|
- **[Automation Examples](automation-examples.md)** - Ready-to-use automation recipes
|
|
- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions
|
|
|
|
## 🚀 Quick Start
|
|
|
|
1. **Install via HACS** (add as custom repository)
|
|
2. **Add Integration** in Home Assistant → Settings → Devices & Services
|
|
3. **Enter Tibber API Token** (get yours at [developer.tibber.com](https://developer.tibber.com/))
|
|
4. **Configure Price Thresholds** (optional, defaults work for most users)
|
|
5. **Start Using Sensors** in automations, dashboards, and scripts!
|
|
|
|
## ✨ Key Features
|
|
|
|
- **Quarter-hourly precision** - 15-minute intervals for accurate price tracking
|
|
- **Statistical analysis** - Trailing/leading 24h averages for context
|
|
- **Price ratings** - LOW/NORMAL/HIGH classification based on your thresholds
|
|
- **Best hour detection** - Automatic detection of cheapest/peak hours
|
|
- **ApexCharts integration** - Custom services for beautiful price charts
|
|
- **Multi-currency support** - EUR, NOK, SEK with proper minor units (ct, øre, öre)
|
|
|
|
## 🔗 Useful Links
|
|
|
|
- [GitHub Repository](https://github.com/jpawlowski/hass.tibber_prices)
|
|
- [Issue Tracker](https://github.com/jpawlowski/hass.tibber_prices/issues)
|
|
- [Release Notes](https://github.com/jpawlowski/hass.tibber_prices/releases)
|
|
- [Home Assistant Community](https://community.home-assistant.io/)
|
|
|
|
## 🤝 Need Help?
|
|
|
|
- Check the [Troubleshooting Guide](troubleshooting.md)
|
|
- Search [existing issues](https://github.com/jpawlowski/hass.tibber_prices/issues)
|
|
- Open a [new issue](https://github.com/jpawlowski/hass.tibber_prices/issues/new) if needed
|
|
|
|
---
|
|
|
|
**Note:** These guides are for end users. If you want to contribute to development, see the [Developer Documentation](../development/).
|