StackGuardian/tirith

Create documentation structure for tirith and bootstrap docs

開放

#131 建立於 2024年4月20日

在 GitHub 查看貢獻者指南
 (10 則留言) (0 個反應) (1 位負責人)Python (41 個分叉)auto 404
enhancementhacktoberfest

倉庫指標

星標
 (168 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
GitDocumentation tools (e.g., Sphinx, MkDocs)
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60