kisp-nus/anvil

Example Cleanup and Documentation

Offen

#44 geöffnet am 24.02.2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)OCaml (10 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (30 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Erstellen Sie ein 'docs' Verzeichnis und verschieben Sie vorhandene Dokumentationsinhalte in separate Markdown Dateien für Tutorial, Sprachreferenz und optional Bibliotheksreferenz.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85