Documentation Improvement
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- elixir
调研方向
No files or tests are named. Begin by reviewing the existing Hexdocs and Surface-UI.org documentation, then determine whether they serve different purposes; done requires a clarified documentation scope and a concrete plan for improving Hexdocs.
由索引模型根据 Issue 内容生成。
描述
Surface is an amazing project.
I think it'll be helpful if increased attention is given to its documentation.
Specifically, why are there two alternative documentations? Hexdocs and Suface-UI.org? Are they to serve different purposes?
I suggest that investing effort into an improved hexdocs page will suffice.
- 主要语言
- Elixir
- 星标
- 2.1k
- 派生
- 146
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
surface-ui/surface 的其他 Issue
-
难度 1/5 1-3 小时 新手友好度 78/100
surface-ui/surface#634 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 35/100
surface-ui/surface#770 ·
-
Website is down未关闭
难度 4/5 3-5 天 新手友好度 35/100
surface-ui/surface#768 · 4 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
surface-ui/surface#762 · 2 条评论 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 35/100
surface-ui/surface#759 · 1 个 reaction ·
查看 surface-ui/surface 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 2 天内回复
-
ci-cd
难度 2/5 1-3 小时 新手友好度 72/100
carverauto/serviceradar#5648 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
Bug Elixir Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 65/100
getsentry/sentry-elixir#1242 · 1 条评论 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
open-telemetry/opentelemetry-erlang-contrib#846 ·
维护者通常 1 天内回复