kisp-nus/anvil

Example Cleanup and Documentation

开放

#44 创建于 2025年2月24日

在 GitHub 查看
 (1 条评论) (0 个反应) (0 位负责人)OCaml (10 个派生)auto 404
documentationenhancementgood first issue

仓库指标

星标
 (30 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
创建一个 'docs' 目录，并将现有文档内容移动到教程、语言参考和（可选）库参考的单独 Markdown 文件中。
技术栈
无
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85