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