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

Make documentation available to LLMs by using llms.txt convention #77

Open
YugoCode opened this issue Dec 19, 2024 · 1 comment
Open

Comments

@YugoCode
Copy link

YugoCode commented Dec 19, 2024

It would be great to enable tools like Cursor to leverage PocketBase’s documentation for generating more accurate and useful code, especially when extending it with Go. The Svelte team recently introduced support for LLMs (see https://svelte.dev/docs/llms) by adopting the llms.txt convention (https://llmstxt.org/), which allows LLM tools to parse documentation effectively. It would be awesome if PocketBase could adopt this convention and ensure the llms.txt file stays updated whenever the documentation changes.

@ganigeorgiev ganigeorgiev transferred this issue from pocketbase/pocketbase Dec 20, 2024
@ganigeorgiev
Copy link
Member

ganigeorgiev commented Dec 20, 2024

After skimming through the llms.txt website it is not clear to me what exactly is the expected result here.

Are you are suggesting to generate one big Markdown file with all the text from the existing HTML documentation?

Would that really help?

I'm not using LLM assistance when coding so I'm not sure how useful that would be. Specifically for documentation and code examples I'll probably never trust it and many users just don't bother with verifying what they are running because it looks "fine" on the surface (there is no guarantee that the generated code will raise a build error and could hide a runtime one, see for example - pocketbase/pocketbase#5989).

In any case, I'll leave the issue open for now but I already have enough on my hands and I'm not planning working on this, so if anyone wants to generate a script to convert the static HTML SvelteKit docs to one or many Markdown files, feel free to open a PR with your suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants