Skip to content

Commit

Permalink
Add warning to storybook README
Browse files Browse the repository at this point in the history
  • Loading branch information
rajsite committed May 22, 2024
1 parent 0832aef commit b156c60
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

Private package containing the Storybook for the Nimble repo.

## Usage warning

This package is the exception to normal package dependency rules by having explicit monorepo path dependencies on nimble-components and spright-components and by inspecting non-public contents such as typescript source code instead of public build artifacts. The package should be not be used as a model of best practices for the nimble monorepo.

## Contributing

See `Getting Started` in [`CONTRIBUTING.md`](/packages/storybook/CONTRIBUTING.md) to get started with building
and running storybook.
and running storybook.

0 comments on commit b156c60

Please sign in to comment.