Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Develop documentation

Aperta
#24 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

Inizia con l’issue #22 e la documentazione introduttiva di Zensical per determinare come debba essere avviato il sito della documentazione. Realizza una prima versione incentrata su Riferimento rapido, Installazione, IO e Ringraziamenti, includendo almeno un esempio completo di generazione di maschere usando napari, X-AnyLabeling, Label Studio o Fiji. Il lavoro è completato quando il sito esiste con queste sezioni iniziali e l’esempio è utilizzabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Following #22, a simple documentation site should be initiated. Preference is Zensical.

Components to add on first pass include:

  • Quick reference: Worked example starting from existing masks
    • A sub-page illustrating how to generate the first mask using a few tools (napari, X-AnyLabeling, Label Studio, Fiji). At least one should go into the first docs produced. Additional examples can be added in subsequent issues.
  • Installation
  • IO: format specifications for what comes into SST and what is produced
  • Acknowledgements
Lingua principale
Jupyter Notebook
Stelle
15
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Imageomics/SST

Tutte le issue di Imageomics/SST

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.