You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Provide a llms-full.txt for the Node.js Docs. #57587
We should add a llm.txt file to our docs set, so the Node.js docs is more fruible to llms. Here is an example of Anthropic's one: https://docs.anthropic.com/llms-full.txt.
This is useful to teach the LLMs about the new APIs they don't know about.
We should ideally include some text also for the individual modules.
Has there been discussion or consideration of whether or not how LLMs are consuming our docs actually follows the license of them? Asking because my personal not-a-lawyer read is that The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. is not actually being respected when consuming/outputting the code in them.
The purpose of docs is to help people use our tools. In 2025, we want developers to be able to use newer Node.js APIs with their tool of choice - very often, this is an AI-assisted editor. However, those editors do not know about the latest Node.js APIs because they usually learn from "old" articles. This will allow devs to teach"
LLMs are scraping this information anyway. We should make life easier for our users unless we want to block LLMs from consuming our source code. I would leave this to the courts to establish its legality and we should not be debating this.
Reacted by Julián Duque, Arka Pratim Chaudhuri and Dave Richer
Activity
mcollina commentedon Mar 22, 2025
cc @nodejs/documentation
AugustinMauroy commentedon Mar 23, 2025
is it basically MDX ?
iyush05 commentedon Mar 25, 2025
Can i work on this.
I was thinking to fetch the html file of the docs page and convert to txt file and then remove all the redundant data.
mcollina commentedon Mar 25, 2025
I think so.
bnb commentedon Mar 25, 2025
Has there been discussion or consideration of whether or not how LLMs are consuming our docs actually follows the license of them? Asking because my personal not-a-lawyer read is that
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.is not actually being respected when consuming/outputting the code in them.mcollina commentedon Mar 26, 2025
The purpose of docs is to help people use our tools. In 2025, we want developers to be able to use newer Node.js APIs with their tool of choice - very often, this is an AI-assisted editor. However, those editors do not know about the latest Node.js APIs because they usually learn from "old" articles. This will allow devs to teach"
LLMs are scraping this information anyway. We should make life easier for our users unless we want to block LLMs from consuming our source code. I would leave this to the courts to establish its legality and we should not be debating this.
ovflowd commentedon May 4, 2025
Can someone close this issue? Related work was done here: nodejs/doc-kit#226