Skip to content

Conversation

gabinfay
Copy link

@gabinfay gabinfay commented Aug 4, 2025

Nota: This PR replaces an old one where I just shared the llms.txt and llms-full.txt without the script to generate them, now the script is here and could be easily integrated in the CI/CD to automatically update the txt files.

Description

Implements llms-txt.org support to expose Ethereum.org's English documentation to AI crawlers and LLMs.
Adds two statically served files:

  • llms.txt: URL index of 256 English documentation pages (~32KB)
  • llms-full.txt: Full content of all pages (~2.8MB), cleaned for AI consumption

Includes a script to generate/update both files and a new npm command for ease of use.

Changes:

  • public/llms.txt – index of all English docs, categorized by topic
  • public/llms-full.txt – full content in markdown format
  • src/scripts/generate-llms-files.js – generation script
  • package.json – adds npm run generate-llms command

Key features:

  • English-only, translations excluded
  • Proper llms.txt formatting
  • Cleaned markdown (no frontmatter, HTML, or JSX)
  • Static serving via Next.js public/ directory
  • Categorized by topic (e.g., developers, staking, community)

Files are accessible at:

Related Issue

N/A

Copy link

netlify bot commented Aug 4, 2025

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit ff5905e
🔍 Latest deploy log https://app.netlify.com/projects/ethereumorg/deploys/68909252d1c136000885622c
😎 Deploy Preview https://deploy-preview-16016--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 41 (🔴 down 10 from production)
Accessibility: 90 (🔴 down 4 from production)
Best Practices: 92 (no change from production)
SEO: 97 (🔴 down 2 from production)
PWA: -
View the detailed breakdown and full score reports

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

@github-actions github-actions bot added dependencies 📦 Changes related to project dependencies tooling 🔧 Changes related to tooling of the project labels Aug 4, 2025
@wackerow
Copy link
Member

Thanks @gabinfay

Could you help me understand more about https://llms-txt.org/?

image image

These "team" callouts don't really instill any confidence in that site. We have https://github.com/ethereum/ethereum-org-website/blob/dev/public/llms.txt (https://ethereum.org/llms.txt) already which breaks down the site into it's topics, can you help me understand the differences?

Does this help or hurt to form a verifiable link of attribution when LLM search results show content pulled from ethereum.org? Thanks

@wackerow wackerow added question ❓ Further information is requested Status: Blocked 🛑 This is blocked and removed dependencies 📦 Changes related to project dependencies labels Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question ❓ Further information is requested Status: Blocked 🛑 This is blocked tooling 🔧 Changes related to tooling of the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants