docs(media): enable autodocs pages for the media stack stories#328
Merged
Conversation
MediaEditor, the MediaEditor Live Demo, and TranscriptView all carry docs.description text but lacked the autodocs tag (157 story files in the repo have it; MediaPlayer already does), so no Docs page was ever generated for them. Also mention the ScriptPanel in the Live Demo description — it was absent. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Enables Storybook-generated Docs pages for the media stack stories by adding the autodocs tag to story meta definitions, and updates the MediaEditor Live Demo’s docs description to include the missing ScriptPanel sentence.
Changes:
- Added
tags: ['autodocs']toTranscriptView,MediaEditor, andMediaEditor Live Demostory metadata so Docs pages are generated. - Extended the MediaEditor Live Demo
docs.description.componenttext to mention the ScriptPanel behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/components/TranscriptView/TranscriptView.stories.tsx | Adds autodocs tag so Storybook generates the Docs page for TranscriptView. |
| src/components/MediaEditor/MediaEditorLive.stories.tsx | Adds autodocs tag and expands Docs description with ScriptPanel details. |
| src/components/MediaEditor/MediaEditor.stories.tsx | Adds autodocs tag so Storybook generates the Docs page for MediaEditor. |
With autodocs enabled, the Live Demo meta was the only autodocs-tagged story under src/components without a `component` (157/157 others have one), so its generated docs page had nothing to document. The demo already imports and renders MediaEditor - declare it. Found by Copilot review on mieweb#328. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
src/components/MediaEditor/MediaEditorLive.stories.tsx:26
metais typed asMetawithout a component generic, but this story now setscomponent: MediaEditor. In this codebase, stories that providecomponentconsistently useMeta<typeof Component>to ensure type safety (e.g.src/components/MediaPlayer/MediaPlayer.stories.tsx:13-16,src/components/ErrorPage/ErrorPage.stories.tsx:9-12). Leaving the generic off can cause TypeScript to treatcomponentasComponentType<Args>and rejectMediaEditor’s props type.
const meta: Meta = {
title: 'Components/Images & Media/MediaEditor Live Demo',
component: MediaEditor,
tags: ['autodocs'],
The story renders the LiveDemo harness, not <MediaEditor {...args}/>, so
the Controls panel autodocs derives from MediaEditor's props would not
drive anything. MediaEditor's own autodocs page keeps the interactive
props table. Also types the meta as Meta<typeof MediaEditor> to match
the other story files.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
garrity-miepub
self-requested a review
July 24, 2026 18:33
garrity-miepub
approved these changes
Jul 24, 2026
garrity-miepub
left a comment
garrity-miepub
left a comment
Collaborator
There was a problem hiding this comment.
Nice! Fills in the last three media components missing autodocs.
garrity-miepub
pushed a commit
that referenced
this pull request
Jul 24, 2026
With autodocs enabled, the Live Demo meta was the only autodocs-tagged story under src/components without a `component` (157/157 others have one), so its generated docs page had nothing to document. The demo already imports and renders MediaEditor - declare it. Found by Copilot review on #328. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Switches on the generated Docs pages for the media stack — MediaEditor, the MediaEditor Live Demo, and TranscriptView all carry
docs.descriptiontext but lacked theautodocstag (157 story files in the repo have it; MediaPlayer already does), so their Docs pages were never generated. Also adds the missing ScriptPanel sentence to the Live demo's description.3 files, +7/−1.
pnpm formatverified locally; no component code touched.