Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide an LLM export of our docs #7971

Open
jprochazk opened this issue Nov 1, 2024 · 0 comments
Open

Provide an LLM export of our docs #7971

jprochazk opened this issue Nov 1, 2024 · 0 comments
Labels
📖 documentation Improvements or additions to documentation

Comments

@jprochazk
Copy link
Member

There's a recent trend for libraries to provide a file that contains enough context about the library for an LLM to be able to act as an assistant for using that library. The idea behind it being a file is that you can provide it to any LLM that supports such an import, and it also makes distribution very easy.

In our case we'd probably build it in the "push to docs-latest" job, and have a button somewhere on our website to download it.

There are some tools that can generate such an export, which we should try out. One such example is repopack.

If none of the available tools are suitable, we'd have to develop something on top of the existing search index build infrastructure. The LLM would likely want a lot more information about the available symbols, their fields/parameters/return types, all the doc comments, full import paths per-language, etc., plus all our examples/snippets. We could limit it to Python-only in the MVP.

@jprochazk jprochazk added the 📖 documentation Improvements or additions to documentation label Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant