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

feat: generate 100k tokens llms.txt #1042

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

Conversation

peterje
Copy link

@peterje peterje commented Jan 29, 2025

  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

summary
implemented a spec-compliant llms.txt generator. This implementation was inspired by vercel/ai's implementation and adapted for our documentation structure.

changes

  • implemented scripts/generate-llms.mjs
  • added generate:llms script to package.json
  • configured output to public/llms.txt to follow the standard web path specification

notes
to stay under a ~100k token limit, some docs have to be omitted. it's not clear how this decision should be made. to start, i've omitted the directories ['pt-br', 'guides', 'solid-router', 'solid-meta', 'configuration'].

Related issues & labels

Copy link

stackblitz bot commented Jan 29, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit cfae29e
🔍 Latest deploy log https://app.netlify.com/sites/solid-docs/deploys/67d72ea5971f050008230a77
😎 Deploy Preview https://deploy-preview-1042--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@LadyBluenotes
Copy link
Member

Hi @peterje, thank you for the time and effort in this pull request. For the time being, I'm going to close it because this is not something currently planned with the docs.

@solidjs solidjs locked and limited conversation to collaborators Jan 29, 2025
@solidjs solidjs unlocked this conversation Feb 13, 2025
@LadyBluenotes LadyBluenotes reopened this Feb 13, 2025
@LadyBluenotes
Copy link
Member

Hi @peterje! I'm repopening this because I brought this up to some people on the team and they agree that it's a good idea to get in place.

I'm going to specifically bring in this PR to get some feedback from the team, so you might see some activity in this PR (via comments or requests for changes) in the next little bit.

@peterje
Copy link
Author

peterje commented Feb 19, 2025

thanks @LadyBluenotes! happy to own this work if requested.

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.

[Request]: Support llms.txt
2 participants