Update code/lib/builder-manager/README.md

Co-authored-by: Yann Braga <yannbf@gmail.com>
This commit is contained in:
Norbert de Langen 2022-08-25 14:01:17 +02:00 committed by GitHub
parent e6411e5cf1
commit dbbe27057e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,11 +1,12 @@
# Manager-Builder
Do not use this package unless you know what you are doing.
Storybook uses this package internally to create the manager side of storybook.
> NOTE: Do not use this package unless you know what you are doing.
This package uses `esbuild` to bundle the manager-side of addons, and prepare it for modern ESM supporting browsers.
This package is used internally by Storybook to create the manager side (UI) of Storybook.
This package uses `esbuild` to bundle the manager-side of addons, and prepare it for modern, ESM supporting browsers.
Each addon is bundled into a separate file, and the manager is responsible for loading them.
In addition, if `manager.*` exists, it's also bundled, and loaded.
If a `manager.*` file exists in the config dir (e.g. `.storybook`), it's also bundled, and loaded in the browser.
Additionally this package also will add the manager ui via the `@storybook/ui` package, which is already build by `esbuild` in our build process before publishing.
Additionally, this package also will add the manager ui via the `@storybook/ui` package, which is already built by `esbuild` in our build process before publishing.