ChoicescriptIDE / ChoicescriptIDE/cslib
Add proper documentation
未关闭
documentation
- 主要语言
- JavaScript
- 星标
- 6
- 派生
- 3
- PR 合并指标
- 30 天内没有已合并 PR
描述
We could use the wiki feature of Github, or add a 'docs' folder with markup for each module.
If we wanted to be _really_ clever, maybe we could parse routine comments? Maybe @diegoboston 's area of expertise?
贡献指南
调研方向
没有指定文件或测试。首先确定文档应放在 GitHub wiki 还是 docs 文件夹中,然后评估 issue 中提到的模块和例程注释。完成这项工作需要就文档方案达成一致,并覆盖这些模块的文档,但 issue 没有定义预期的格式或范围。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100