[ci][docs] make docs LLM friendly as per new standards #1114
Unanswered
chartotu19
asked this question in
Questions
Replies: 1 comment
-
This will be awesome. I think this will make cursor and aider make less mistakes when generating typer code. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
First Check
Commit to Help
Example Code
Description
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
Operating System
Other
Operating System Details
No response
Typer Version
0.12.5
Python Version
3.12
Additional Context
No response
Beta Was this translation helpful? Give feedback.
All reactions