-
Notifications
You must be signed in to change notification settings - Fork 4
Add script for generating llms.txt and llms-full.txt #222
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
Conversation
| const fileContent = fs.readFileSync(indexPath, 'utf-8'); | ||
| const match = fileContent.match(/---\s*title:\s*(.*?)\s*---/); | ||
| const title = match ? match[1] : path.basename(file); | ||
| const url = `https://docs.api3.org${file}`; |
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.
I realized that the links in the hinter net docs weren't full
|
Visit the preview URL for this PR (updated for commit 4fc15bd): https://oev-docs--pr222-llms-evy8886b.web.app (expires Tue, 02 Sep 2025 13:52:19 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 6915b094b5ba83fde754632ba50c1ee9406d433f |
dcroote
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.
Cool. One big issue though: all of the llms.txt links are broken because they use the .md extension rather than the built / published .html.
Also, I feel this is motivation to improve some titles. For example, llms-full.txt has one topline header as # Quickstart. Quickstart what? Since the page hierarchy isn't well captured in llms-full.txt, maybe "dApps Quickstart"? etc.
|
All very good points, thanks |
dcroote
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.
Nice 👍 and clever on the header text clues
Siegrift
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.
👍 LGTM (I only browsed the generated content for LLM and it looks pretty good).
Closes #187
https://oev-docs--pr222-llms-evy8886b.web.app/llms.txt
https://oev-docs--pr222-llms-evy8886b.web.app/llms-full.txt