Skip to content
Vy logo
Guides

Contribute to the documentation

Dokumentasjonen til Spor er bare så god som bidragene den mottar. Men hvordan bidrar man egentlig?

Å få tilgang er egentlig relativt greit.

Be om tilgang

Ta kontakt med Per Øyvind Weum, Hilde S. Hatt eller Kristofer Giltvedt Selbekk for å få en invitasjon til Sanity-installasjonen vår. Når du har fått tilgang, kan du gå til spor.cloud.vy.no/studio. Der vil du se noe á la det her:

Et skjermbilde av Sanity Studio, med alle innholdstypene til venstre.

Skjermbilde fra Sanity Studioet vårt

Struktur

Alle innholdssidene er implementert som en "Article". Dette gjelder både komponenter, ressurser og til og med denne siden. Trykk deg inn og endre det du ønsker. Når du er ferdig trykker du på Publish. Enkelt og greit.

For komponentdokumentasjonen, er de delt inn i tre forskjellige seksjoner – eksempler, retningslinjer og kode.

Eksemplene skal helst være enkle å forstå, ha lite forklarende innhold, og være enkle å copy paste inn i egen kode.

Retningslinjene forklarer når du burde bruke en komponent, og hvordan du burde gjøre det. Disse gjelder både for designere og utviklere.

Kode-seksjonen inneholder referanser til "komponent"-dokumenter, som er tekniske dokumenter. Disse definerer hver komponent, inkludert hvilke props de inkluderer.

Tone of voice

Prøv å skriv beskrivende, på norsk, og uten å skrive mer enn du trenger.

Vær gjerne litt vittig i eksemplene, og bruk gjerne tog- og kollektivtransporthumor om muligheten byr seg.