Documentation: Add CLAUDE.md and docs for AI coding assistants #33568
+2,301
−414
Conversation
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
|
View your CI Pipeline Execution ↗ for commit 86e2163
☁️ Nx Cloud last updated this comment at |
Contributor
📝 WalkthroughWalkthroughAdds multiple documentation and Claude skill files across the repo, updates .gitignore to track the skills directory, and removes an existing Copilot instructions document. Changes are purely documentation and configuration; no executable code or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@code/core/README.md`:
- Line 803: The README contains a broken link text "[CLAUDE.local.md]" pointing
to a nonexistent file; update the link target and display text to the actual
filename "CLAUDE.md" (i.e., replace occurrences of "CLAUDE.local.md" with
"CLAUDE.md" in the affected line in code/core/README.md) so the link points to
"../../CLAUDE.md" and renders correctly.
🧹 Nitpick comments (7)
scripts/README.md (1)
7-30: Add language specifiers to fenced code blocks.Several fenced code blocks are missing language specifiers, which affects syntax highlighting and accessibility. Consider adding language identifiers:
- Lines 7-30:
textorplaintextfor directory tree- Lines 127-153:
textfor ASCII art dependency graph- Lines 161-163:
textfor pipeline flow- Lines 179-181:
textfor pipeline flow- Lines 212-225:
textfor pipeline steps- Lines 266-281:
textfor directory structure- Lines 289-299:
textfor ASCII art diagramExample fix for the directory structure
-``` +```text scripts/ ├── task.ts # Main task runner entry point ...Also applies to: 127-153, 161-176, 179-194, 212-225, 266-281, 289-299
scripts/release/README.md (1)
13-34: Add language specifiers to fenced code blocks.Two fenced code blocks are missing language specifiers:
- Lines 13-34: Directory structure should use
textorplaintext- Lines 280-292: Branch strategy diagram should use
textThis improves syntax highlighting and accessibility.
Example fixes
-``` +```text scripts/release/ ├── version.ts # Bump versions across all packages ...-``` +```text next ─────────────────────────────────────────────► (development) │ ...Also applies to: 280-292
.claude/skills/canary/SKILL.md (2)
29-31: Optional: Add language specifier to code block.The version format code block could benefit from a language specifier for better rendering and syntax highlighting.
Minor markdown improvement
-``` +```text 0.0.0-pr-<PR_NUMBER>-sha-<SHORT_SHA></details> --- `68-68`: **Optional: Format bare URL as markdown link.** The URL could be formatted as a proper markdown link for better accessibility and consistency. <details> <summary>Minor markdown improvement</summary> ```diff -https://github.com/storybookjs/storybook/actions/workflows/publish.yml +[View workflow runs](https://github.com/storybookjs/storybook/actions/workflows/publish.yml)CLAUDE.md (2)
16-16: Optional: Add language specifiers to code blocks for better rendering.Several code blocks are missing language specifiers, which can improve syntax highlighting and readability. As per coding guidelines, consider running Prettier to format the file.
Example locations: lines 16, 35, 77, 85, 212, 272.
Example fix for line 16
-``` +```text storybook/ ├── code/</details> Also applies to: 35-35, 77-77, 85-85, 212-212, 272-272 --- `312-341`: **Optional: Add blank lines around tables for markdown compliance.** Several tables lack surrounding blank lines, which is flagged by markdown linters. Consider adding blank lines before and after tables at lines 312, 321, 330, and 337. </blockquote></details> <details> <summary>code/core/README.md (1)</summary><blockquote> `7-7`: **Optional: Add language specifiers to code blocks.** Several code blocks are missing language specifiers. As per coding guidelines, consider running `yarn prettier --write code/core/README.md` to format the file. Example locations: lines 7, 68, 107, 119, 249, 340. Also applies to: 68-68, 107-107, 119-119, 249-249, 340-340 </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
code/core/README.md
Outdated
| ## Related Documentation | ||
|
|
||
| Learn more about Storybook at [storybook.js.org](https://storybook.js.org/?ref=readme). | ||
| - [CLAUDE.local.md](../../CLAUDE.local.md) - Monorepo architecture overview |
Contributor
There was a problem hiding this comment.
Fix incorrect file reference.
The link references CLAUDE.local.md but the file is named CLAUDE.md (without .local).
🔗 Fix the broken link
-- [CLAUDE.local.md](../../CLAUDE.local.md) - Monorepo architecture overview
+- [CLAUDE.md](../../CLAUDE.md) - Monorepo architecture overview📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - [CLAUDE.local.md](../../CLAUDE.local.md) - Monorepo architecture overview | |
| - [CLAUDE.md](../../CLAUDE.md) - Monorepo architecture overview |
🤖 Prompt for AI Agents
In `@code/core/README.md` at line 803, The README contains a broken link text
"[CLAUDE.local.md]" pointing to a nonexistent file; update the link target and
display text to the actual filename "CLAUDE.md" (i.e., replace occurrences of
"CLAUDE.local.md" with "CLAUDE.md" in the affected line in code/core/README.md)
so the link points to "../../CLAUDE.md" and renders correctly.
kasperpeulen
force-pushed
the
kasper/claude-support
branch
from
07db423 to
7065763
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In @.claude/skills/canary/SKILL.md:
- Around line 53-57: Replace the incomplete fragment "Or upgrade a" in the
SKILL.md content with a complete sentence such as "Or upgrade an existing
project:" and ensure the following bash example remains as a properly fenced
code block (the snippet starting with "npx storybook@<VERSION_FROM_PR>
upgrade"); update the sentence to match the style of the preceding example for
clarity and consistency.
In `@code/core/README.md`:
- Around line 800-804: Update the documentation link that incorrectly references
CLAUDE.local.md: locate the "Related Documentation" section in core/README.md
and change the link text/reference from
"[CLAUDE.local.md](../../CLAUDE.local.md)" to "[CLAUDE.md](../../CLAUDE.md)" so
it points to the existing CLAUDE.md file; leave the scripts/README.md entry
unchanged.
In `@scripts/release/README.md`:
- Around line 38-70: Update the README example for the version bump command so
the --release-type option lists all supported semver types; change the command
shown for yarn release:version --release-type to include premajor, preminor, and
prepatch (i.e. use <major|minor|patch|premajor|preminor|prepatch|prerelease>),
keeping the rest of the `version.ts` documentation (deferred mode, steps) intact
so it matches the implementation of the yarn release:version command.
♻️ Duplicate comments (1)
code/core/README.md (1)
803-803: Fix incorrect file reference.The link references
CLAUDE.local.mdbut the file is namedCLAUDE.md(without.local).🔗 Fix the broken link
-- [CLAUDE.local.md](../../CLAUDE.local.md) - Monorepo architecture overview +- [CLAUDE.md](../../CLAUDE.md) - Monorepo architecture overview
🧹 Nitpick comments (4)
.claude/skills/canary/SKILL.md (1)
29-31: Consider markdown formatting improvements.Two optional markdown improvements to align with best practices:
- The version format code block (line 29) could specify a language identifier
- The bare URL (line 68) could be formatted as a proper markdown link
♻️ Proposed improvements
For the version format block:
-``` +```text 0.0.0-pr-<PR_NUMBER>-sha-<SHORT_SHA>For the monitoring URL: ```diff -Watch the workflow run at: -https://github.com/storybookjs/storybook/actions/workflows/publish.yml +Watch the workflow run at: +[GitHub Actions: publish.yml](https://github.com/storybookjs/storybook/actions/workflows/publish.yml)Also applies to: 68-68
scripts/README.md (1)
7-7: Optional: Add language identifiers to diagram code blocks.Several fenced code blocks containing ASCII diagrams/structures don't specify a language identifier. While this doesn't affect rendering for most viewers, adding
textor leaving them without a language is fine, but for consistency with markdown linting tools, you could addtextidentifiers.This is a very minor style improvement and can be safely deferred or skipped. The diagrams are clear and effective as-is.
Also applies to: 127-127, 212-212, 289-289
CLAUDE.md (1)
16-16: Optional: Minor markdown formatting improvements.The document has several minor markdown linting issues:
- Fenced code blocks without language identifiers (lines 16, 35, 77, 85, 212, 272)
- Tables without surrounding blank lines (lines 312, 321, 330, 337)
These are purely stylistic and don't affect readability. You can address them by:
- Adding
textlanguage identifiers to ASCII diagram blocks- Adding blank lines before/after tables
This is a very minor style improvement and can be safely deferred. The documentation is clear and effective as-is. If you want to ensure full compliance with markdown linters, you can run
yarn prettier --write CLAUDE.mdper the coding guidelines.Also applies to: 35-35, 77-77, 85-85, 212-212, 272-272, 312-312, 321-321, 330-330, 337-337
.claude/skills/storybook-upgrade/SKILL.md (1)
37-52: Consider adding post-upgrade steps.The documentation covers the upgrade command well, but users might benefit from guidance on post-upgrade steps (e.g., restart the dev server, verify installation, check for breaking changes in changelogs).
📝 Suggested addition
- Never skip major versions (e.g., don't go from 8.x directly to 10.x) + +## After upgrading + +1. Restart your dev server if it's running +2. Verify the installation: `npx storybook --version` +3. Check the changelog for breaking changes at https://github.com/storybookjs/storybook/blob/next/CHANGELOG.md +4. Test your stories to ensure they render correctly
Comment on lines
+53
to
+57
| Or upgrade a | ||
|
|
||
| ```bash | ||
| npx storybook@<VERSION_FROM_PR> upgrade | ||
| ``` |
Contributor
There was a problem hiding this comment.
Complete the sentence.
Line 53 has an incomplete sentence fragment: "Or upgrade a" should likely read "Or upgrade an existing project:" to match the pattern of the previous example.
📝 Proposed fix
-Or upgrade a
+Or upgrade an existing project:
```bash
npx storybook@<VERSION_FROM_PR> upgrade📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Or upgrade a | |
| ```bash | |
| npx storybook@<VERSION_FROM_PR> upgrade | |
| ``` | |
| Or upgrade an existing project: | |
🤖 Prompt for AI Agents
In @.claude/skills/canary/SKILL.md around lines 53 - 57, Replace the incomplete
fragment "Or upgrade a" in the SKILL.md content with a complete sentence such as
"Or upgrade an existing project:" and ensure the following bash example remains
as a properly fenced code block (the snippet starting with "npx
storybook@<VERSION_FROM_PR> upgrade"); update the sentence to match the style of
the preceding example for clarity and consistency.
Comment on lines
+38
to
+70
| ### `version.ts` - Version Bumping | ||
|
|
||
| Bumps versions across all packages in the monorepo. | ||
|
|
||
| ```bash | ||
| cd scripts | ||
|
|
||
| # Bump by release type | ||
| yarn release:version --release-type <major|minor|patch|prerelease> | ||
|
|
||
| # With prerelease identifier | ||
| yarn release:version --release-type prerelease --pre-id alpha | ||
|
|
||
| # Set exact version | ||
| yarn release:version --exact 7.2.0-beta.0 | ||
|
|
||
| # Deferred bump (writes to deferredNextVersion, doesn't bump yet) | ||
| yarn release:version --release-type minor --deferred | ||
|
|
||
| # Apply a deferred bump | ||
| yarn release:version --apply | ||
| ``` | ||
|
|
||
| **What it does:** | ||
| 1. Reads current version from `code/package.json` | ||
| 2. Calculates next version using semver | ||
| 3. Updates `code/package.json` version | ||
| 4. Updates `code/core/src/manager-api/version.ts` | ||
| 5. Updates `code/core/src/common/versions.ts` | ||
| 6. Updates all package.json files in workspaces | ||
| 7. Runs `yarn install --mode=update-lockfile` | ||
|
|
||
| **Deferred mode:** Used in CI to separate version calculation from actual bumping. The preparation workflow sets `deferredNextVersion`, and the publish workflow applies it. |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if version.ts exists and examine its command-line options
# First, locate the file
find . -name "version.ts" -path "*/release/*" -type f
# Then examine its contents for command-line parsing
if [ -f "scripts/release/version.ts" ]; then
echo "=== Checking version.ts implementation ==="
cat scripts/release/version.ts
else
echo "Checking for version.ts in related locations..."
find . -name "version.ts" -type f
fiRepository: storybookjs/storybook
Length of output: 10623
Update --release-type option to include all supported release types.
The documentation lists --release-type <major|minor|patch|prerelease>, but the implementation also supports premajor, preminor, and prepatch. Update line 45 to:
yarn release:version --release-type <major|minor|patch|premajor|preminor|prepatch|prerelease>All documented workflow steps and deferred mode behavior are accurate and match the implementation.
🤖 Prompt for AI Agents
In `@scripts/release/README.md` around lines 38 - 70, Update the README example
for the version bump command so the --release-type option lists all supported
semver types; change the command shown for yarn release:version --release-type
to include premajor, preminor, and prepatch (i.e. use
<major|minor|patch|premajor|preminor|prepatch|prerelease>), keeping the rest of
the `version.ts` documentation (deferred mode, steps) intact so it matches the
implementation of the yarn release:version command.
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 2 | 🚨 +2 🚨 |
| Self size | 0 B | 184 KB | 🚨 +184 KB 🚨 |
| Dependency size | 0 B | 2.98 MB | 🚨 +2.98 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-docs
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 18 | 🚨 +18 🚨 |
| Self size | 0 B | 1.64 MB | 🚨 +1.64 MB 🚨 |
| Dependency size | 0 B | 9.25 MB | 🚨 +9.25 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-links
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 1 | 🚨 +1 🚨 |
| Self size | 0 B | 14 KB | 🚨 +14 KB 🚨 |
| Dependency size | 0 B | 5 KB | 🚨 +5 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-onboarding
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 0 | 0 |
| Self size | 0 B | 331 KB | 🚨 +331 KB 🚨 |
| Dependency size | 0 B | 670 B | 🚨 +670 B 🚨 |
| Bundle Size Analyzer | Link | Link |
storybook-addon-pseudo-states
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 0 | 0 |
| Self size | 0 B | 21 KB | 🚨 +21 KB 🚨 |
| Dependency size | 0 B | 689 B | 🚨 +689 B 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-themes
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 1 | 🚨 +1 🚨 |
| Self size | 0 B | 18 KB | 🚨 +18 KB 🚨 |
| Dependency size | 0 B | 28 KB | 🚨 +28 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/addon-vitest
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 2 | 🚨 +2 🚨 |
| Self size | 0 B | 379 KB | 🚨 +379 KB 🚨 |
| Dependency size | 0 B | 338 KB | 🚨 +338 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/builder-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 11 | 🚨 +11 🚨 |
| Self size | 0 B | 123 KB | 🚨 +123 KB 🚨 |
| Dependency size | 0 B | 1.30 MB | 🚨 +1.30 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/builder-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 188 | 🚨 +188 🚨 |
| Self size | 0 B | 75 KB | 🚨 +75 KB 🚨 |
| Dependency size | 0 B | 32.04 MB | 🚨 +32.04 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 49 | 🚨 +49 🚨 |
| Self size | 0 B | 20.39 MB | 🚨 +20.39 MB 🚨 |
| Dependency size | 0 B | 16.52 MB | 🚨 +16.52 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/angular
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 188 | 🚨 +188 🚨 |
| Self size | 0 B | 139 KB | 🚨 +139 KB 🚨 |
| Dependency size | 0 B | 30.27 MB | 🚨 +30.27 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/ember
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 192 | 🚨 +192 🚨 |
| Self size | 0 B | 15 KB | 🚨 +15 KB 🚨 |
| Dependency size | 0 B | 28.76 MB | 🚨 +28.76 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/html-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 14 | 🚨 +14 🚨 |
| Self size | 0 B | 22 KB | 🚨 +22 KB 🚨 |
| Dependency size | 0 B | 1.46 MB | 🚨 +1.46 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 534 | 🚨 +534 🚨 |
| Self size | 0 B | 646 KB | 🚨 +646 KB 🚨 |
| Dependency size | 0 B | 59.53 MB | 🚨 +59.53 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 123 | 🚨 +123 🚨 |
| Self size | 0 B | 1.12 MB | 🚨 +1.12 MB 🚨 |
| Dependency size | 0 B | 22.11 MB | 🚨 +22.11 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preact-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 14 | 🚨 +14 🚨 |
| Self size | 0 B | 13 KB | 🚨 +13 KB 🚨 |
| Dependency size | 0 B | 1.44 MB | 🚨 +1.44 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-native-web-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 155 | 🚨 +155 🚨 |
| Self size | 0 B | 30 KB | 🚨 +30 KB 🚨 |
| Dependency size | 0 B | 23.41 MB | 🚨 +23.41 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 113 | 🚨 +113 🚨 |
| Self size | 0 B | 35 KB | 🚨 +35 KB 🚨 |
| Dependency size | 0 B | 19.91 MB | 🚨 +19.91 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 274 | 🚨 +274 🚨 |
| Self size | 0 B | 24 KB | 🚨 +24 KB 🚨 |
| Dependency size | 0 B | 44.43 MB | 🚨 +44.43 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/server-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 200 | 🚨 +200 🚨 |
| Self size | 0 B | 16 KB | 🚨 +16 KB 🚨 |
| Dependency size | 0 B | 33.30 MB | 🚨 +33.30 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/svelte-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 19 | 🚨 +19 🚨 |
| Self size | 0 B | 55 KB | 🚨 +55 KB 🚨 |
| Dependency size | 0 B | 26.58 MB | 🚨 +26.58 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/sveltekit
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 20 | 🚨 +20 🚨 |
| Self size | 0 B | 56 KB | 🚨 +56 KB 🚨 |
| Dependency size | 0 B | 26.63 MB | 🚨 +26.63 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/vue3-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 108 | 🚨 +108 🚨 |
| Self size | 0 B | 35 KB | 🚨 +35 KB 🚨 |
| Dependency size | 0 B | 43.67 MB | 🚨 +43.67 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/web-components-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 15 | 🚨 +15 🚨 |
| Self size | 0 B | 19 KB | 🚨 +19 KB 🚨 |
| Dependency size | 0 B | 1.50 MB | 🚨 +1.50 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 183 | 🚨 +183 🚨 |
| Self size | 0 B | 775 KB | 🚨 +775 KB 🚨 |
| Dependency size | 0 B | 67.55 MB | 🚨 +67.55 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 176 | 🚨 +176 🚨 |
| Self size | 0 B | 30 KB | 🚨 +30 KB 🚨 |
| Dependency size | 0 B | 66.13 MB | 🚨 +66.13 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/core-webpack
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 1 | 🚨 +1 🚨 |
| Self size | 0 B | 11 KB | 🚨 +11 KB 🚨 |
| Dependency size | 0 B | 28 KB | 🚨 +28 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
create-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 50 | 🚨 +50 🚨 |
| Self size | 0 B | 1000 KB | 🚨 +1000 KB 🚨 |
| Dependency size | 0 B | 36.91 MB | 🚨 +36.91 MB 🚨 |
| Bundle Size Analyzer | node | node |
@storybook/csf-plugin
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 9 | 🚨 +9 🚨 |
| Self size | 0 B | 7 KB | 🚨 +7 KB 🚨 |
| Dependency size | 0 B | 1.26 MB | 🚨 +1.26 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
eslint-plugin-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 20 | 🚨 +20 🚨 |
| Self size | 0 B | 131 KB | 🚨 +131 KB 🚨 |
| Dependency size | 0 B | 2.82 MB | 🚨 +2.82 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-dom-shim
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 0 | 0 |
| Self size | 0 B | 18 KB | 🚨 +18 KB 🚨 |
| Dependency size | 0 B | 788 B | 🚨 +788 B 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preset-create-react-app
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 68 | 🚨 +68 🚨 |
| Self size | 0 B | 32 KB | 🚨 +32 KB 🚨 |
| Dependency size | 0 B | 5.98 MB | 🚨 +5.98 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preset-react-webpack
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 170 | 🚨 +170 🚨 |
| Self size | 0 B | 18 KB | 🚨 +18 KB 🚨 |
| Dependency size | 0 B | 31.29 MB | 🚨 +31.29 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preset-server-webpack
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 10 | 🚨 +10 🚨 |
| Self size | 0 B | 7 KB | 🚨 +7 KB 🚨 |
| Dependency size | 0 B | 1.20 MB | 🚨 +1.20 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/html
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 2 | 🚨 +2 🚨 |
| Self size | 0 B | 29 KB | 🚨 +29 KB 🚨 |
| Dependency size | 0 B | 32 KB | 🚨 +32 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preact
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 2 | 🚨 +2 🚨 |
| Self size | 0 B | 16 KB | 🚨 +16 KB 🚨 |
| Dependency size | 0 B | 32 KB | 🚨 +32 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 57 | 🚨 +57 🚨 |
| Self size | 0 B | 1.23 MB | 🚨 +1.23 MB 🚨 |
| Dependency size | 0 B | 12.95 MB | 🚨 +12.95 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/server
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 3 | 🚨 +3 🚨 |
| Self size | 0 B | 8 KB | 🚨 +8 KB 🚨 |
| Dependency size | 0 B | 716 KB | 🚨 +716 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/svelte
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 2 | 🚨 +2 🚨 |
| Self size | 0 B | 45 KB | 🚨 +45 KB 🚨 |
| Dependency size | 0 B | 230 KB | 🚨 +230 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/vue3
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 3 | 🚨 +3 🚨 |
| Self size | 0 B | 63 KB | 🚨 +63 KB 🚨 |
| Dependency size | 0 B | 211 KB | 🚨 +211 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/web-components
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 3 | 🚨 +3 🚨 |
| Self size | 0 B | 61 KB | 🚨 +61 KB 🚨 |
| Dependency size | 0 B | 47 KB | 🚨 +47 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
kasperpeulen
force-pushed
the
kasper/claude-support
branch
3 times, most recently
from
4e61874 to
1f6e3f5
Compare
Add comprehensive documentation to help AI coding assistants (Claude, Cursor, etc.) understand the Storybook codebase: - CLAUDE.md: Architecture guide with key concepts, directory structure, and common commands - code/core/README.md: Detailed core package documentation - scripts/README.md: Task runner and sandbox system documentation - scripts/release/README.md: Release automation documentation - .claude/skills/: Claude Code skills for common workflows (canary, upgrade, PR, QA labels) Removed .github/copilot-instructions.md - GitHub Copilot coding agent now supports CLAUDE.md from repo root, making it the single source of truth for all AI assistants. Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
kasperpeulen
force-pushed
the
kasper/claude-support
branch
from
1f6e3f5 to
e67a8b8
Compare
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.
What I did
Added comprehensive documentation to help AI coding assistants (Claude Code, Cursor, Windsurf, GitHub Copilot, etc.) understand the Storybook codebase:
Why CLAUDE.md replaces copilot-instructions.md
The old
.github/copilot-instructions.mdand newCLAUDE.mdhave similar line counts (~415 vs ~470), but CLAUDE.md packs more useful information per line:Key improvements:
Why delete copilot-instructions.md:
GitHub Copilot coding agent supports
CLAUDE.mdfrom repo root (changelog). One file for all AI assistants = no duplicate maintenance.Other changes
README.md→CONTRIBUTING.mdfor detailed docs (code/core, scripts, scripts/release)code/core/README.mdfor npm package pageChecklist for Contributors
Testing
Manual testing
No manual testing required - documentation only changes.
Documentation
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.