crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 创建于 2023年10月4日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Python (18 fork)github user discovery
documentationhacktoberfest-acceptedhelp wanted

仓库指标

Star
 (13 star)
PR 合并指标
 (PR 指标待抓取)

描述

  • Move the getting started section from the readme into its own file in the docs folder
  • Link to the new getting started file in the docs folder once created, from other places that reference it:
  • Try them out and make corrections as needed

贡献者指南

研究方向
将 README.md 中的“入门”部分移到 docs/ 下的一个新文件中（例如 docs/getting started.md）。更新所有引用：README.md、CONTRIBUTING.md 和 ReadTheDocs 索引页面（docs/index.rst 或类似文件）。验证链接并测试说明。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitMarkdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85