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