Addon Docs: Make new code panel opt in #30248
Merged
Conversation
This file contains 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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
code/addons/docs/src/manager.tsx
Outdated
| parameters[PARAM_KEY].codePanel === false | ||
| ); | ||
| }, | ||
| disabled: (parameters) => !!parameters?.docs?.codePanel, |
There was a problem hiding this comment.
logic: This logic is incorrect - it disables the panel when codePanel is true, which is the opposite of what the documentation suggests. Should be !parameters?.docs?.codePanel to disable when false/undefined.
|
View your CI Pipeline Execution ↗ for commit 523f051.
☁️ Nx Cloud last updated this comment at |
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 59 | 59 | 0 |
| Self size | 410 KB | 228 KB | 🎉 -183 KB 🎉 |
| Dependency size | 13.46 MB | 13.46 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-essentials
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 36 | 36 | 0 |
| Self size | 17 KB | 12 KB | 🎉 -4 KB 🎉 |
| Dependency size | 13.83 MB | 13.83 MB | 🎉 -160 B 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-mdx-gfm
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 69 | 69 | 0 |
| Self size | 4 KB | 3 KB | 🎉 -1 KB 🎉 |
| Dependency size | 2.41 MB | 2.41 MB | 0 B |
| Bundle Size Analyzer | Link | Link |
shilman
force-pushed
the
shilman/docs-disable-codepanel
branch
from
97c64f7 to
b451851
Compare
valentinpalkovic
approved these changes
Jan 13, 2025
7 tasks
valentinpalkovic
changed the title
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.
Closes N/A
What I did
There are some open questions about the new code panel. Since we don't have time to address them before 8.5, making the panel opt in instead of opt out for now.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Codepanel by defaultdocs.codePanelparameter totrueand observe theCodepanel when you restart your storybook.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Makes the code panel in Storybook docs addon opt-in rather than opt-out by default, requiring explicit enablement through the
docs.codePanelparameter.disabledlogic incode/addons/docs/src/manager.tsxto disable panel by defaultparameters.docs.codePanel = true