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.

Sign up for GitHub

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

Jump to bottom

LLM friendly docs #200

Open
chartotu19 opened this issue Jan 6, 2025 · 2 comments · May be fixed by #199
Open

LLM friendly docs #200

chartotu19 opened this issue Jan 6, 2025 · 2 comments · May be fixed by #199

Comments

@chartotu19
Copy link

chartotu19 commented Jan 6, 2025 •
edited
Loading

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
@chartotu19 chartotu19 linked a pull request Jan 6, 2025 that will close this issue
Open
@Kludex
Copy link
Owner

Kludex commented Jan 7, 2025

Do you have examples of projects doing this?

@chartotu19
Copy link
Author

There are quite a few of projects using them (directories [1] [2]) . Looking at some of the project's Github workflows, it looks likely that the managed hosting service (mintlify, vercel) is generating it automatically for them NOT via a Github Action. I checked that github-pages or readthedocs dont support this natively, hence this PR.

Few example projects and their llms.txt links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: new action to generate llms.txt, .md files in CI demodrive-ai/python-multipart
2 participants
@chartotu19 @Kludex