我正在创建一个向量存储，以便为Llamaindex做出贡献，我想知道是否应该按照文档中的说明，使用mkdocs和文档构建器将示例笔记本添加到文档中。我尝试这样做，但在某些库方面遇到了一些问题，在尝试解决这些问题之前，我想确保这样做是必要的(在贡献指南中没有提到将示例笔记本添加到文档中)。
7tofc5zh1#
是的，你应该在为LlamaIndex做贡献时将示例笔记本添加到文档中。贡献指南鼓励添加示例笔记本，特别是如果你已经将LlamaIndex应用于独特的用例。这是“3. 🎉 添加使用示例”部分的一部分。你可以使用prepare_for_build.py脚本在docs目录中自动将示例笔记本添加到文档中。笔记本应该放在llama-index-packs/llama-index-packs-koda-retriever/examples/中。如果你在使用库时遇到问题，请确保遵循pyproject.toml文件中列出的具体版本要求和可选依赖项，以避免兼容性问题。如果需要进一步的帮助，可以考虑查阅LlamaIndex Documentation或在Discord上联系LlamaIndex Community Support。在添加你的笔记本之前，请使用tonic-validate工具按照pyproject.toml文件中的指示对其进行验证。这一步确保你的贡献符合项目的标准和要求。
prepare_for_build.py
docs
llama-index-packs/llama-index-packs-koda-retriever/examples/
pyproject.toml
tonic-validate
来源
此响应旨在提供帮助并节省时间。它不是精确的解决方案,而是你自己研究的起点。帮助我变得更有用！如果这有帮助请留下一个👍，如果无关请留下一个👎。
1条答案
按热度按时间7tofc5zh1#
是的，你应该在为LlamaIndex做贡献时将示例笔记本添加到文档中。贡献指南鼓励添加示例笔记本，特别是如果你已经将LlamaIndex应用于独特的用例。这是“3. 🎉 添加使用示例”部分的一部分。你可以使用
prepare_for_build.py脚本在docs目录中自动将示例笔记本添加到文档中。笔记本应该放在llama-index-packs/llama-index-packs-koda-retriever/examples/中。如果你在使用库时遇到问题，请确保遵循
pyproject.toml文件中列出的具体版本要求和可选依赖项，以避免兼容性问题。如果需要进一步的帮助，可以考虑查阅LlamaIndex Documentation或在Discord上联系LlamaIndex Community Support。在添加你的笔记本之前，请使用
tonic-validate工具按照pyproject.toml文件中的指示对其进行验证。这一步确保你的贡献符合项目的标准和要求。详细信息
来源
关于Dosu
此响应旨在提供帮助并节省时间。它不是精确的解决方案,而是你自己研究的起点。
帮助我变得更有用！如果这有帮助请留下一个👍，如果无关请留下一个👎。