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

[feat] Add /llms.txt and /llms-full.txt for Enhanced LLM Access to Documentation #12566

Closed
thomasmol opened this issue Jan 30, 2025 · 1 comment

Comments

@thomasmol
Copy link

Describe the problem

I use LLMs a lot to write code but they often struggles to index and parse the latest Tauri docs properly. A lot of the times it starts suggesting code from v1 for example. I would like to be able to add the proper latest docs to the context window or at least create embeddings for it to get better answers and code generation

Describe the solution you'd like

Add two files, /llms.txt and /llms-full.txt, as described in https://llmstxt.org/, to the Tauri website (something like tauri.app/llms.txt):

  1. /llms.txt:
    • a summary index in markdown format with key links and project overview.
  2. /llms-full.txt
    • markdown file containing the full documentation. this single document would allow llms to index the entire docs in one pass without navigating page-by-page. also useful for llms that have large context windows to just add the full docs as input like a system prompt

Alternatives considered

No response

Additional context

other projects have done the same already and it works great! Some examples: https://svelte.dev/docs/llms and https://developers.cloudflare.com/llms.txt

@thomasmol
Copy link
Author

Closing in favor of tauri-apps/tauri-docs#3144

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

No branches or pull requests

1 participant