StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

オープン

#131 opened on 2024/04/20

GitHub で見るコントリビューターガイド
 (10 件のコメント) (0 件のリアクション) (1 人の担当者)Python (41 件のフォーク)auto 404
enhancementhacktoberfest

Repository metrics

Stars
 (168 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Brainstorm about:

  • What are the structures for the docs? (a good start would be to research readthedocs)
  • Good docs examples
  • Best if the docs is optimized for vector database for integration with the RAG

Update (22/04/2024):

  • Find the right structure and write a concrete docs, would be great if we have multiple structure options to compare
    • Goal: optimized for RAG, readable for human

cc @samriddhi99

コントリビューターガイド

調査方針
ReadTheDocsのようなドキュメント構造を調査し、RAG（例：ベクトルデータベースの使用）に最適化する方法を探ります。RAGの互換性と人間の可読性に焦点を当てて、複数の構造オプションを比較してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
GitDocumentation tools (e.g., Sphinx, MkDocs)
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60