-
-
Notifications
You must be signed in to change notification settings - Fork 2k
docs(www): add llms.txt files #4893
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for ngrx-io canceled.Built without sensitive environment variables
|
✅ Deploy Preview for ngrx-site-v19 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@timdeschryver There is a website called firecrawl that provides an endpoint to get llms files. Potentially, you could setup a monthly API request to get a new file. Also, you would need to vet security of using this. Looking at GitHub action solutions:
Note: the workflow code needs to be slightly tweaked to commit newly created file back to the main branch. |
I should mention that using the markdown itself in the llms-full.txt file shouldn't trip up the AI (having |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
There are no LLMS.txt files to help AI tools.
Partially #4804
What is the new behavior?
Expose LLMS.txt on new docs site.
The
llms-full.txt
file contains mostly all markdown content files from thewww
folder. I removed some architecture entries that have no real content. I usedgitingest.com
and removed the extra file headers it adds. The full file is very large. I removed some repeated stuff in the markdown files like the maintenance mode warning of the data package and the recommendation to use signals store. Things like recommendations are likely better suited to a cursor rules or something similar. I put the files in the public folder of the www folder. The NgRx docs doesn't have a public folder and I guess that stuff is getting removed so I decided to just add this to the new docs.Does this PR introduce a breaking change?
Other information