Documentation
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
检查仓库的声明，以确定需要 docstrings 的公共 IPLD API。然后调查 doc-gen4 是否能够生成所请求的文档页面；当这些声明已完成文档编写，并且可行性或生成的文档页面已被记录时，工作即告完成。
由索引模型根据 Issue 内容生成。
描述
Why
The repo is meant to provide an API for IPLD but it's currently undocumented, which makes its use harder (and maybe error prone)
How
- Add docstrings to declarations
- Check the possibility of using
doc-gen4to create a pretty documentation page
- 主要语言
- Lean
- 星标
- 8
- 派生
- 1
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
相似的 Issue
-
could docs good first issue
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
suitenumerique/find#206 ·
维护者通常 2 天内回复
-
README em inglês未关闭good first issue help wanted priority:p2 type:docs
难度 2/5 1-3 小时 新手友好度 76/100
lucacasanova/homedeck#122 ·
-
needs-triage
难度 1/5 1 小时以内 新手友好度 78/100
bherbruck/solvecraft#11729 · 1 条评论 · 1 个 reaction ·
-
area: cli area: docs documentation effort: small good first issue help wanted patch-candidate
难度 2/5 1-3 小时 新手友好度 72/100
drevendev/HungryCrab#601 ·
维护者通常 1 天内回复