-
-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Labels
area: config flowRelated to configuration flowRelated to configuration flowarea: coordinatorRelated to data coordinatorRelated to data coordinatorarea: sensorsRelated to sensor entitiesRelated to sensor entitiesarea: servicesRelated to servicesRelated to servicesdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Description
The documentation could benefit from updated and comprehensive screenshots to help users better understand the integration's features and setup process.
Tasks
- Take screenshots of the integration setup/config flow
- Capture screenshots of all available sensors and their data
- Add screenshots of the Home Assistant UI showing the integration in action
- Document camera entity screenshots (if applicable)
- Add screenshots of service calls and their usage
- Ensure screenshots are in a consistent style and resolution
- Update README.md and other docs with new screenshots
- Store screenshots in appropriate directory (e.g.,
resources/images/ordocs/images/)
Additional Context
Good documentation with visual examples significantly improves the user experience and reduces support questions. Screenshots should show:
- Clean, professional looking Home Assistant dashboards
- Clear examples of sensor data
- Setup wizards and configuration options
- Integration of Spoolman data in the UI
Acceptance Criteria
- All major features are visually documented
- Screenshots are clear and high quality
- Images are properly referenced in documentation
- File sizes are optimized for web viewing
Metadata
Metadata
Assignees
Labels
area: config flowRelated to configuration flowRelated to configuration flowarea: coordinatorRelated to data coordinatorRelated to data coordinatorarea: sensorsRelated to sensor entitiesRelated to sensor entitiesarea: servicesRelated to servicesRelated to servicesdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed