docs(#98): add Storybook how-to for app developers and contributors - #104
Conversation
Explains how to use Storybook to render components with mock data without needing Essentials or a Crestron processor, and how to inject state into the Redux store (via devicesActions.setDeviceState / roomsActions.setRoomState) as though it were sent from Essentials, including replaying a captured real session. Storybook is not currently configured anywhere in this repo; these docs establish the pattern for consuming apps and flag the one real library gap it runs into (slice reducers aren't part of the public export surface yet). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds new Storybook documentation intended to help (1) app developers render mobile-control-react-app-core components against mocked Redux/WebSocket data and (2) contributors understand library-side gaps that currently make that workflow harder.
Changes:
- Adds an app-developer “how-to” for using Storybook with mocked Redux state (and guidance to avoid
MobileControlProvider/ the singleton store). - Adds contributor notes describing the current reducer-export gap and a potential
createMockStorefactory approach for the library.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/storybook-app-dev.md | App-developer guide for Storybook usage with mock Redux state and session replay patterns. |
| docs/storybook-contributors.md | Contributor-facing notes on library-side export gaps and suggested improvements to support the app-dev Storybook workflow. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Add documentation explaining how to create a per-story Redux store and import RootState to ensure isolation and proper typing in Storybook stories.
|
🎉 This PR is included in version 1.25.0-add-zoom.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.24.1-cache-busting.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.25.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Summary
Adds Storybook documentation for app developers and contributors.
docs/storybook-app-dev.md— how-to guide for app developers using Storybookdocs/storybook-contributors.md— guide for contributors extending Storybook setupCloses #98
🤖 Generated with Claude Code