reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 建立於 2023年6月27日

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

描述

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!)

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic MarkdownGit and GitHubFamiliarity with mintlifyLocal development environment
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
Investigate the existing documentation site structure, likely found in the repository's docs/ folder or a separate mintlify configuration. Review the mintlify documentation to understand its syntax and capabilities. Engage with the comments on the issue (there are 24) to see if maintainers have provided specific preferences or templates. Then create a new guide page following the existing style.
✨ Create a guide on how to update the documentation website · reworkd/AgentGPT#869 | Good First Issue