Skip to content

Provide a llms-full.txt for the Node.js Docs. #57587

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

Open
mcollina opened this issue Mar 22, 2025 · 6 comments
Open

Provide a llms-full.txt for the Node.js Docs. #57587

mcollina opened this issue Mar 22, 2025 · 6 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@mcollina
Copy link
Member

mcollina commented Mar 22, 2025

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.

@mcollina
Copy link
Member Author

cc @nodejs/documentation

@AugustinMauroy
Copy link
Member

Here is an example of Anthropic's one: https://docs.anthropic.com/llms-full.txt.

is it basically MDX ?

@bjohansebas bjohansebas added the doc Issues and PRs related to the documentations. label Mar 24, 2025
@iyush05
Copy link

iyush05 commented 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
Copy link
Member Author

Here is an example of Anthropic's one: https://docs.anthropic.com/llms-full.txt.

is it basically MDX ?

I think so.

@bnb
Copy link
Contributor

bnb commented 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
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

5 participants