Commit graph

4 commits

Author SHA1 Message Date
Julian Pawlowski
ab9735928a refactor(docs): update terminology from "services" to "actions" for clarity and consistency 2025-12-02 18:35:59 +00:00
Julian Pawlowski
76b0d0a766 docs(user): add dynamic icon and color guides for dashboard customization
Added comprehensive user documentation for visual dashboard customization:

- docs/user/icon-colors.md: New guide for using icon_color attribute
  * Explains CSS variable approach for theme compatibility
  * Shows when to use icon_color vs state interpretation
  * Examples for Custom Button Card, Entities Card, Mushroom, Glance
  * Custom color override options (theme-based and direct)
  * All state values use lowercase (HA convention)

- docs/user/dynamic-icons.md: New guide for automatic icon changes
  * Explains state-based icon behavior without cataloging specifics
  * Dashboard examples with standard and custom cards
  * Icon override instructions for fixed icons
  * Binary sensor icon behavior details
  * Integration with dynamic colors

- Updated cross-references in README.md, sensors.md, automation-examples.md
  to link both new guides

Impact: Users can now create visually rich dashboards with color-coded and
icon-changing sensors without writing complex conditional logic. Documentation
focuses on principles and practical examples rather than exhaustive listings,
making it easy to understand and maintain.
2025-11-15 18:00:38 +00:00
Julian Pawlowski
3dc1a49465 feat(docs): enhance period calculation documentation and add detailed guides for best/peak price periods 2025-11-10 11:54:06 +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