Skip to content

Conversation

@91volt
Copy link

@91volt 91volt commented Nov 25, 2025

Summary

This PR rewrites the documentation for the Bedtime Story Teller example to provide complete setup instructions, explain the random generation feature, and clarify the application architecture.

What changed

Documentation:

  • Description: Expanded the overview to cover the dual workflow (manual configuration vs. random generation) and the real-time streaming capability.
  • Setup Instructions: Added a detailed guide on how to duplicate the App and configure the API Key using the Brick Configuration menu, replacing the previous placeholder steps.
  • Usage Guide: Documented the specific parameters available (Age, Theme, Characters) and the interaction flow for generating stories.
  • Technical Explanation: Added "How it Works" and "Understanding the Code" sections to explain the prompt engineering logic in Python and the WebSocket streaming handling in JavaScript.
  • Requirements: Updated the hardware list and emphasized the need for an active internet connection and valid API Key.

--

Notes

Screenshots need updates once tested with enabled cloud llm brick in bricks list.

Matteo-it and others added 24 commits October 31, 2025 09:53
…ation

Ensured the 'clear-story-button' is explicitly set to display: 'block' and is enabled after both random test story generation and actual story generation via socket.io response. This addresses the user's request for the button to be visible and clickable once a story has been generated.
Enhanced the 'resetStoryView' function to clear all selected parameters, input fields, and reset the UI state of the parameter containers to their initial configuration. This includes deselecting chips, clearing textareas and character inputs, and managing the visibility and state of parameter containers and the 'Generate story' button.
Added 'background-attachment: fixed;' and 'background-repeat: no-repeat;' to the '.play-area' class. This ensures the background image remains fixed to the viewport and does not resize or move when the content height changes, providing a more stable visual experience.
Removed the 'Generate randomly' button from the UI, the associated 'generateRandomTestStory' function, and its event listener. This change prepares the application for use with the live Arduino backend by removing test-specific code.
* Update audio classification doc (arduino#6)

* PR 143 Migration to up to date repository

---------

Co-authored-by: Mirko Curtolo <[email protected]>
@91volt 91volt changed the base branch from Matteo-it/storyteller to release-1.0 November 25, 2025 16:16
@91volt 91volt changed the base branch from release-1.0 to Matteo-it/storyteller November 25, 2025 16:17
@91volt 91volt changed the base branch from Matteo-it/storyteller to release-1.0 November 25, 2025 16:18
@91volt 91volt marked this pull request as ready for review November 25, 2025 16:24
@91volt 91volt changed the title docs: update bedtime story teller docs docs: update bedtime story teller Nov 25, 2025
Copy link

@mcmchris mcmchris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@91volt 91volt requested a review from stefanotorneo November 26, 2025 08:18
Copy link
Contributor

@stefanotorneo stefanotorneo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stefanotorneo stefanotorneo merged commit f8c2d75 into arduino:release-1.0 Nov 27, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants