1766701 - Document Storybook in Firefox Source Docs

Status: RESOLVED FIXED

(Firefox :: General, task, P3)

Description

[Mark Striemer [:mstriemer]]

There's a README.md in the storybook folder, but we should get the docs on Firefox Source Docs too. At least how to get it running, but also some examples of writing a story would be good too.

Comment 1

[Tim Giles [:tgiles]]

Attachment: Bug 1766701 - Document Storybook usage in Firefox Source Docs. r=mstriemer!,hjones!

This document serves as an overview to how Storybook is used in Firefox.
Additionally, it serves as a reference point to more detailed
information that exists when running our Storybook locally.

Comment 2

[Tim Giles [:tgiles]]

Attachment: Bug 1766701 - Split existing README.stories.md into two docs. r=hjones

I couldn't see a better way of preventing two <h1> elements in one
document, so I split the document into two parts. This also prevents
Firefox Source Docs from being confused by the two "Background" <h2>
elements since it converts headings into elements with IDs.

Depends on D169386

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/00b23dd73202
Document Storybook usage in Firefox Source Docs. r=mstriemer,hjones
https://hg.mozilla.org/integration/autoland/rev/a20aa54e7695
Split existing README.stories.md into two docs. r=hjones,mstriemer

Comment 4

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/00b23dd73202
https://hg.mozilla.org/mozilla-central/rev/a20aa54e7695

Comment 5

[Tim Giles [:tgiles]]

I got some paths wrong in the docs, so the two new docs aren't showing up in Firefox Source Docs. Re-opening to fix that issue.

Comment 6

[Tim Giles [:tgiles]]

Attachment: Bug 1766701 - Fix Storybook docs paths in Firefox Source Docs. r=hjones

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e802d90b76a5
Fix Storybook docs paths in Firefox Source Docs. r=hjones DONTBUILD

Comment 8

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/e802d90b76a5