DeployBoard / DeployBoard/deployboard-python

Update Docs

未关闭
#74 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation enhancement
主要语言
Python
星标
10
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

**Is your feature request related to a problem? Please describe.**
Lots of pages on the docs are just empty placeholders and is not very helpful.

**Describe the solution you'd like**
We need to update the docs to provide more information. I'm not sure at this time what the "minimum" would be for v1.0.0, but it needs to be enough for a new user to be able to launch the application and start using without questions.

**Describe alternatives you've considered**
None

**Additional context**
None

贡献指南

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

调研方向

该 issue 没有列出文档文件、测试或入口点;首先清点空的占位页面,并查看新用户如何启动应用程序。在编辑之前,确定 v1.0.0 的最低限度指南;当新用户能够启动并开始使用应用程序,且基本问题都得到解答时,即可认为工作完成。

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

评估

领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

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