Improve Endpoint Documentation
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 领域
- api, documentation
调研方向
从链接的 API 文档 https://api.leighhack.org/docs 开始，检查 FastAPI 端点定义，以确定当前记录了哪些内容。扩展端点文档，使其描述每个端点的用途，然后验证已发布的文档涵盖所有端点。
由索引模型根据 Issue 内容生成。
描述
Documentation is available at https://api.leighhack.org/docs but only has the basics. We need to extend them out to describe what each endpoint does.
- 主要语言
- Python
- 星标
- 0
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
leigh-hackspace/hackspace-api 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 25/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
难度 5/5 一周以上 新手友好度 15/100
查看 leigh-hackspace/hackspace-api 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
PedestrianDynamics/pyFDS-Evac#343 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
theskumar/python-dotenv#708 ·
-
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 2 天内回复
-
Docs Timedelta
难度 2/5 1-3 小时 新手友好度 72/100
pandas-dev/pandas#69919 ·
维护者通常 1 天内回复
-
API documentation
难度 2/5 1-3 小时 新手友好度 72/100
zephyrproject-rtos/west#1009 · 2 条评论 ·
维护者通常 3 天内回复