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 docs LLM friendly #1922

Open
chartotu19 opened this issue Jan 7, 2025 · 0 comments · May be fixed by #1923
Open

make docs LLM friendly #1922

chartotu19 opened this issue Jan 7, 2025 · 0 comments · May be fixed by #1923

Comments

@chartotu19
Copy link

chartotu19 commented Jan 7, 2025

Actual Situation

I use cursor IDE to assist with my development. In my typical workflow, I @ the docs page to add knowledge to LLMs for better code generation. Most popular coding models work really well with markdown but docs website have only html content.

There is a proposal to serve llms.txt, llms-full.txt and .md extension for each docs page - https://llmstxt.org/. To make websites LLM friendly.

Docs companies like mintlify offer this out of the box as a feature. Also, there are public directories [1] [2] that show 112 projects are using it already. Some examples:

Desired Situation

New endpoints to assist LLM agents to better parse copier docs.

https://copier.readthedocs.io/llms.txt
https://copier.readthedocs.io/llms-full.txt
https://copier.readthedocs.io/en/stable/reference/cli/index.md
...
...

Proposed solution

Add a Github Action to generate these markdown files, llms.txt prior to docs deployment.

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

Successfully merging a pull request may close this issue.

1 participant