POC: Customizing Storybook’s Automatic Docs Page

[alizedebray]

Storybook can automatically create documentation pages using information from our components. Currently, we do not use this feature because we want a custom page layout that fits our needs better.

However, there is a middle ground: we can customize the automatic docs page to look and behave the way we want, without building everything from scratch. This way, the documentation will update automatically when components change, but still have the style and structure we require.

As part of the POC, you will try implementing these custom automatic docs pages on different types of components (HTML/CSS components, Web Components, utilities,...) to answer the following questions:

• Do custom docs pages work well in practice?
• Are they customizable enough to meet our needs?
• How do they compare to our current docs pages in terms of code readability and maintainability?
• If we decide to adopt them, how much work will it take to migrate all our docs pages?
• Can we and should we update all our docs pages to use custom automatic docs? If not, which types of pages are suitable or unsuitable?
• What are the limitations and potential risks?

---

Resources

• Storybook documentation on customizing automatic docs pages:
  https://storybook.js.org/docs/writing-docs/doc-blocks#customizing-the-automatic-docs-page

[myrta2302]

Input from the Documentation Workshop: "Create fix order of notifications (deprecated, etc.), title, description, story, code-panel, control-table, etc.
This would be beneficial for the user experience."