Closed Bug 1766701 Opened 2 years ago Closed 1 year ago

Document Storybook in Firefox Source Docs

Categories

(Firefox :: General, task, P3)

task

Tracking

()

RESOLVED FIXED
112 Branch
Tracking Status
firefox112 --- fixed

People

(Reporter: mstriemer, Assigned: tgiles)

References

(Blocks 1 open bug)

Details

(Whiteboard: [recomp])

Attachments

(3 files)

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.

Assignee: nobody → mstriemer
Severity: -- → N/A
Priority: -- → P3
Blocks: storybook
Whiteboard: [fidefe-reusable-components-ms1]
Whiteboard: [fidefe-reusable-components-ms1] → [fidefe-reusable-components-ms2]
Assignee: mstriemer → tgiles
Status: NEW → ASSIGNED

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.

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

Pushed by tgiles@mozilla.com:
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
Status: ASSIGNED → RESOLVED
Closed: 1 year ago
Resolution: --- → FIXED
Target Milestone: --- → 112 Branch

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.

Status: RESOLVED → REOPENED
Resolution: FIXED → ---
Pushed by tgiles@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/e802d90b76a5
Fix Storybook docs paths in Firefox Source Docs. r=hjones DONTBUILD
Status: REOPENED → RESOLVED
Closed: 1 year ago1 year ago
Resolution: --- → FIXED
Blocks: 1818767
Whiteboard: [fidefe-reusable-components-ms2] → [recomp]
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: