Replies: 1 comment
-
Omfanget var ikke så stort ser det ut som, men kanskje spesielt Webfonts er et savn når en setter opp et prosjekt fra scratch |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hvilke steg i prosessen er utført?
Er ønsket tilknyttet et problem? Fortell oss mer!
Det er ikke alltid lett å finne fram til dokumentasjonen for enkelte pakker. Det første stedet jeg leter etter dokumentasjon for en pakke er i portalen, men ikke alle pakker er dokumentert ordentlig der. Et eksempel er
@fremtind/jkl-webfonts
. Det er ingen henvisning til denne pakken annet enn en lenke under Profil og Typografi som går direkte til fontfilene. Derfra må jeg få med meg at jeg står inni en mappe som har en README og en package-fil ett nivå opp.Beskriv løsningen du ønsker
Jeg burde kunne finne informasjonen jeg trenger i portalen uansett hvilken pakke i Jøkul det er jeg skal bruke. Pakker som ikke er det typiske "CSS + React"-paret må fremdeles dokumenteres.
@fremtind/jkl-core
har etablert et mønster som kan fungere.Hvilke alternativer har du vurdert?
Jeg tenkte på at vi kanskje skulle ha tatt selve READMEene og gjort dem til sider inne på portalen i et nytt "Pakker"-område, men siden det ville konkurrert med Komponenter på toppnivå tenker jeg dette ikke er den beste løsningen. "Pakker" kunne kanskje blitt en underside av Kom i gang og Bygg med Jøkul, men selv da ville det vært to konkurrerende områder å gå til for dokumentasjon om en komponent.
Mer info
Liste med pakker som mangler portaldokumentasjon:
browserslist-config-jkl
progress-bar
ogprogress-bar-react
(ser docs: remove progress bar documentation from portal #1981, noen grunn til at den ikke ble merket eksperimentell i stedet?)jkl-webfonts
Beta Was this translation helpful? Give feedback.
All reactions