Guide til dokumentering
På design.sparebank1.no samler vi all informasjonen om hva som finnes i designsystemet, hvordan vi bruker det og hvordan vi bidrar inn
Viktig at informasjonen er oppdatert
Alle må kunne stole på at det som står i dokumentasjonen er oppdatert og riktig. Hjelp oss med å holde dokumentasjonen oppdatert når du gjør endringer eller legger til noe nytt og spennende.
Tilgang til dokumentasjonen
Akkurat nå ligger selve dokumentasjonen i et annet repo enn selve designsystem-koden. Ta kontakt med designsystem-teamet for å få hjelp til tilgang.
Endring av innhold
Alt innhold i dokumentasjonen er skrevet i markdown-filer. For å opppdatere en eksisterende side:
- Finn riktig markdown-fil. Alle filene skal ha navn som matcher den faktiske sidetittelen
- Gjør endringene du ønsker i markdown
- Opprett en pull request
Designsystem-teamet reviewer pull requesten din, og du kan merge så fort den har blitt godkjent.
Eksempler på komponentene
Eksemplene på komponentene ligger i Storybook, sammen med koden i designsystem-repoet. Nye eksempler legges til som stories der.