reworkd/AgentGPT

✨ Create a guide on how to update the documentation website

Open

#869 opened on 2023年6月27日

GitHub で見る
 (24 comments) (0 reactions) (0 assignees)TypeScript (34,594 stars) (9,446 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.