From e6411e5cf17bba9e392065b810ddc7014711d59a Mon Sep 17 00:00:00 2001 From: Norbert de Langen Date: Thu, 25 Aug 2022 12:43:04 +0200 Subject: [PATCH] add a README contents to manager-builder package --- code/lib/builder-manager/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/code/lib/builder-manager/README.md b/code/lib/builder-manager/README.md index 0c6fc3084a8..e0209a2d5c4 100644 --- a/code/lib/builder-manager/README.md +++ b/code/lib/builder-manager/README.md @@ -1,3 +1,11 @@ # Manager-Builder -TODO +Do not use this package unless you know what you are doing. +Storybook uses this package internally to create the manager side 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. + +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.