kisp-nus/anvil

Example Cleanup and Documentation

Ouverte

#44 ouverte le 24 févr. 2025

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)OCaml (10 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (30 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Créez un répertoire 'docs' et déplacez le contenu de la documentation existante dans des fichiers markdown séparés pour le tutoriel, la référence du langage et éventuellement la référence de la bibliothèque.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85