Skip to content

Commit 94e98d7

Browse files
authored
Document usage of Lookbook for ViewComponents (#11540)
changelog: Internal, Documentation, Document usage of Lookbook for ViewComponents
1 parent 570d0c1 commit 94e98d7

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/frontend.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@ and independent view components, rendered server-side.
175175

176176
For more information, refer to the [components `README.md`](../app/components/README.md).
177177

178+
To preview components and their available options, we use [Lookbook](https://lookbook.build/) to
179+
generate a navigable index of our available components. These previews are available at the [`/components/` route](http://localhost:3000/components/)
180+
in local development, review applications, and in the `dev` environment. When adding a new component
181+
or an option to an existing component, you should also make this component or option available in
182+
Lookbook previews, found under [`spec/components/previews`](https://github.com/18F/identity-idp/tree/main/spec/components/previews).
183+
Refer to [Lookbook's _Previews Overview_ documentation](https://lookbook.build/guide/previews) for
184+
more information on how to author Lookbook previews.
185+
178186
#### React
179187

180188
For non-trivial client-side interactivity, we use [React](https://reactjs.org/) to build and combine

0 commit comments

Comments
 (0)