reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 建立於 2023年6月27日

在 GitHub 查看
 (24 留言) (0 反應) (0 負責人)TypeScript (9,446 fork)batch import
good first issuehelp wanted

倉庫指標

Star
 (34,594 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

We should update the docs site (https://docs.reworkd.ai/development) with some documentation for how to update the docs site itself. It should cover the following:

  • Intro on what mintlify is and link to it
  • Talk about how to run the site locally
  • Talk about how to update a page or create a new page
  • Talk about exactly what we want documented
  • Talk about how to request for documentation (Make an issue on GitHub!)

貢獻者指南

研究方向
調查現有文件站點結構，可能在儲存庫的 docs/ 資料夾或單獨的 mintlify 配置中。查閱 mintlify 文件以了解其語法和功能。查看該議題下的評論（共有 24 條），了解維護者是否提供了具體偏好或模板。然後按照現有風格建立一個新的指南頁面。
技術棧
typescript
領域
developer experience
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80