Document usage of Lookbook for ViewComponents#11540
Conversation
changelog: Internal, Documentation, Document usage of Lookbook for ViewComponents
|
|
||
| To preview components and their available options, we use [Lookbook](https://lookbook.build/) to | ||
| generate a navigable index of our available components. These previews are available at the [`/components/` route](http://localhost:3000/components/) | ||
| in local development, review applications, and in the `dev` environment. When adding a new component |
There was a problem hiding this comment.
should we just link the dev environment? or are trying to minimize crawling of it?
There was a problem hiding this comment.
It was intentional to add some light friction here with the assumption that there's enough detail to help the target audience find their way to the page, without directly linking to the deployed environment. (I think we don't usually link there?)
There was a problem hiding this comment.
prob fine to leave as-is
|
|
||
| To preview components and their available options, we use [Lookbook](https://lookbook.build/) to | ||
| generate a navigable index of our available components. These previews are available at the [`/components/` route](http://localhost:3000/components/) | ||
| in local development, review applications, and in the `dev` environment. When adding a new component |
There was a problem hiding this comment.
Is it worth noting that the component_previews_enabled feature flag toggles visibility on/off?
There was a problem hiding this comment.
I think we could, but I can't personally imagine much need to change it from its defaults, so didn't want to dilute the critical information here.
Do you think there's a use-case to be turning it on and off?
eileen-nava
left a comment
eileen-nava
left a comment
There was a problem hiding this comment.
This is helpful, thank you for adding the documentation. 🙏🏻
3 participants
🛠 Summary of changes
Expands on the "View Components" section of the Frontend Architecture documentation to detail our use of Lookbook for component previews.
Related Slack discussion: https://gsa-tts.slack.com/archives/C0NGESUN5/p1732049308670279
📜 Testing Plan
Review proposed text as being easy-to-understand and without typos.