kisp-nus/anvil

Example Cleanup and Documentation

Open

#44 opened on Feb 24, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)OCaml (10 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (30 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Create a 'docs' directory and move existing documentation content into separate markdown files for tutorial, language reference, and optionally library reference.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85