kisp-nus/anvil

Example Cleanup and Documentation

Aperta

#44 aperta il 24 feb 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)OCaml (10 fork)auto 404
documentationenhancementgood first issue

Metriche repository

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

Descrizione

The following parts:

  • Tutorial
  • Language reference
  • Library reference (after we have a standard library)

Let's just use markdown files in a docs directory, zero setup:

  • tutorial: can include tutorial Anvil code here too
  • langref
  • stdref

Guida contributor

Direzione di ricerca
Crea una directory 'docs' e sposta il contenuto della documentazione esistente in file markdown separati per tutorial, riferimento del linguaggio e, opzionalmente, riferimento della libreria.
Tech stack
Nessuno
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.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85