Light-Transcoder / Light-Transcoder/light-transcoder

Improve documentation

未关闭
#11 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

documentation help wanted
主要语言
JavaScript
星标
8
派生
3
PR 合并指标
30 天内没有已合并 PR

描述

Write a good documentation about the API

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 未指定文件、测试或具体入口点。首先定位项目的 HTTP API,并识别其公开端点;添加完整且可用的 API 指南后即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
api, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。