Lepší README
未关闭
还没有人认领这个 Issue。
technical
- 主要语言
- Python
- 星标
- 46
- 派生
- 115
- PR 合并指标
- 30 天内没有已合并 PR
描述
Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559
Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
从 README 开始，并查看所引用的 pull request #559。检查现有的 MkDocs 和 mkdocs-material 文档，总结如何运行项目、网站的用途，以及它不再承担哪些职责。当 README 能够将读者引导至相关文档，并清晰涵盖设置和用途时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100