jerdra/niviz-rater

DOC: Initial documentation

Aperta

#4 aperta il 7 dic 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (4 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (2 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The following documentation components would be good to cover for new users:

Getting started

  1. Tutorial dataset (host images on OSF) + expected dataset structure
  2. YAML specification for constructing views
  3. UI overview (grouping, shortcuts)

Guida contributor

Direzione di ricerca
Esamina la struttura attuale del repository e la documentazione esistente. Esplora l'applicazione per capire come vengono configurate le viste tramite YAML. Raccogli screenshot ed esempi per la guida utente. Controlla il README per le istruzioni di installazione per eseguire l'app localmente.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80