[draft] chore(ffe-buttons-react): Forbedring av dokumentasjon på knappene is storybook. #2502
Conversation
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://black-beach-0d62d0d03-2502.westeurope.2.azurestaticapps.net |
There was a problem hiding this comment.
Vi bør kanskje diskutere hvordan vi vil dokumentere ting med storybook. Jeg er egentlig fan av å dokumentere komponenten mest mulig p åvanlig måte og la storybook plukke det opp, men ser og at det er enkelte ting storybook ikke plukker opp lsik ting er satt opp nå.
| docs: { | ||
| description: { | ||
| component: | ||
| 'ActionButton er en knapp som brukes for å trigge en handling.', |
There was a problem hiding this comment.
Jeg prøvde meg litt frem her. Egentlig så skal storybook støtte at denne ligger i docstringen til komponenten, men ser ikke ut til at det fungerer når vi bruker mdx filer.
Jeg klarer ikke å se hvor denne docstringen dukker opp i den bygde storybooken?
Det er jo en beskrivelse og i .mdx fila for actionbutton?
| }, | ||
| }, | ||
| isLoading: { | ||
| description: 'Viser en spinner når knappen laster', |
There was a problem hiding this comment.
Disse beskrivelsene kan vel og legges på propnivå og storybook fanger det opp? så er det nærmere komponenten
La oss ta en sesjon sammen med denne PR-en hvor vi ser på hvordan vi kan dokumentere selve koden og få det over til storybook. Setter den som draft. |
hagenek
changed the title
Beskrivelse
Lagt til endel forklarende tekst og andre forbedringer.
Motivasjon og kontekst
Testing
Spinn opp storybook lokalt på branchen eller gå på azure deploymenten og sammenlign med prod.