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 (9,446 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (34,594 stars)
PR merge metrics
 (30d に merged 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 のドキュメントを確認し、その構文と機能を理解します。この issue のコメント（24件あります）を確認し、メンテナーが特定の好みやテンプレートを提供しているかどうかを確認します。その後、既存のスタイルに従って新しいガイドページを作成します。
技術スタック
typescript
領域
developer experience
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80