Skip to content
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

add a tutorial walking the reader through adding llms.txt to their project #33

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

radekosmulski
Copy link
Contributor

This needs more work, but I'm adding this to kick things off.

First of all, I am not sure if this statement is accurate?

While Markdown files work best, don't worry if you have other formats - any text format that an LLM can understand (like plain text, HTML, or even CSV) will work just fine.

I can try this tomorrow but thought that maybe someone already might know this :) Or maybe there is a problem here on a conceptual level -- maybe even if the tool would handle this, this is for one reason or another discouraged?

I quite like the idea of making this useable in as many contexts as possible!

And secondly, I am not sure how to serve it using quarto and where on the site this should live? I can probably come up with a suggestion to both tomorrow, but again -- maybe there would be someone who could recommend a path to take on this as... I lack the context. 😄

And last but not least, of course, any feedback on the post is welcome. Happy to make any changes to make this better!

@jph00
Copy link
Contributor

jph00 commented Jan 20, 2025

Thanks for this. :D IMO the prose has too many exclamation marks and overall could be toned down quite a bit -- it currently reads like a classicly over-enthusiastic LLM output.

To add to the site, modify nbs/sidebar.yml.

Perhaps we should rename the "Guidelines" section in the sidebar to "tutorials"?

Whilst in theory I guess CSV or HTML would work, they're not generally a great choice for LLM context. HTML isn't concise enough, and CSV rarely has useful documentation info.

@radekosmulski
Copy link
Contributor Author

Holy smokes! That is some outstanding feedback @jph00! Thank you so much for it 🙏 🙏 🙏

I am afraid that the "overenthusiastic" tone cannot entirely be blamed on the LLM 😄 I may have encouraged and amplified some of it. I feel I need to calibrate my own tone sensor, now that we get this super powerful editing for conciseness and directness (and proper English).

So yes, thank you so much for your feedback on so many levels, this is very valuable to me. Will get the new version up here in a short while!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants