refactor: update Storybook configuration, and enhance documentation#16
Merged
Conversation
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Contributor
Reviewer's GuideRefines Storybook’s configuration and UI theming, introduces an introductory docs page, reorganizes story hierarchy, and adds brand assets (favicon and logo) for the Flux Design System. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The
Introduction.mdxfile is importingMetafrom@storybook/addon-docs/blocks, which is deprecated in newer Storybook versions; consider switching to@storybook/blocksto align with the current API. - The custom sidebar CSS injected via
managerHeadin.storybook/main.tscould be harder to maintain as a string; consider moving this styling into a dedicatedmanager-head.htmlor CSS file so it can be edited and validated more easily.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `Introduction.mdx` file is importing `Meta` from `@storybook/addon-docs/blocks`, which is deprecated in newer Storybook versions; consider switching to `@storybook/blocks` to align with the current API.
- The custom sidebar CSS injected via `managerHead` in `.storybook/main.ts` could be harder to maintain as a string; consider moving this styling into a dedicated `manager-head.html` or CSS file so it can be edited and validated more easily.
## Individual Comments
### Comment 1
<location path=".storybook/manager.ts" line_range="7" />
<code_context>
+addons.setConfig({
+ theme: create({
+ base: 'light',
+ brandImage: './flux.svg',
+ brandTitle: 'Flux Design System',
+ brandTarget: '_self',
</code_context>
<issue_to_address>
**issue (bug_risk):** Use an absolute path for `brandImage` to align with `staticDirs` configuration.
Because `staticDirs` serves `public` from the root, `flux.svg` will be exposed as `/flux.svg`. A relative path like `'./flux.svg'` may not resolve correctly in the manager UI, so using `brandImage: '/flux.svg'` will be more reliable.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Summary by Sourcery
Update Storybook configuration and theming to better showcase the Flux Design System and provide an introductory documentation page.
New Features:
Enhancements: