-
Notifications
You must be signed in to change notification settings - Fork 104
added llms.txt, llms-full.txt, copy markdown button #768
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
filmaj
left a comment
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.
Thanks for the PR, this is interesting. I had to read up on https://llmstxt.org to understand the purpose of this.
I have an immediate concern and that is reading the file system on every HTTP request to llms-full.txt. I don't think we get crazy traffic but still. At a minimum, I'd want to cache the read and compiled text into a closure variable at the top of the handler, so that the doc files are only read on every cold boot of a Lambda rather than on every request.
My other concern is the design of the 'copy markdown' button 😬 I don't have any specific suggestion or recommendation on how to fix that, sorry 😞 It feels in the way for me. I wonder if there's a more subtle treatment we could do 🤔
|
Agree about cache; should be easy to add a cache-control header in the response for those new routes. 24 hours would be fine. We don't change frequently! Could we change the copy button to have no text? I think users recognize that symbol |
These are great suggestions. I think this is the benefit of contributing for me is there are a lot of things I'll learn by working with you all that I think would help me just generally be better at the craft. I'll update this with these changes. Thanks! |
|
As for the CI failures, if you rebase with latest |
2028142 to
e6de70a
Compare
|
@filmaj and @brianleroux what needs to happen here for this to get merged? I added the requested updates just didn't want to leave it hanging and/or if I missed something wanted to check |
Add LLMs Support✨
I have found that having llms.txt and llms-full.txt support and the ability to copy the markdown for a given page quickly allows for quickly working with LLMs to create/debug architect applications
To maintain a high standard of quality in our releases, before merging every pull request we ask that you've completed the following:
Here are the changes:
Checks:
mainnpm itfrom the repo root)readme.md, help docs, inline docs & comments, etc.)[ ] Linked to any related issues, PRs, etc. below that may relate to, consume, or necessitate these changes