Skip to content

feat: automate llms.txt and developers/docs/llms.txt generation#18234

Merged
pettinarip merged 3 commits into
devfrom
feat/llms-txt-automation
May 27, 2026
Merged

feat: automate llms.txt and developers/docs/llms.txt generation#18234
pettinarip merged 3 commits into
devfrom
feat/llms-txt-automation

Conversation

@pettinarip
Copy link
Copy Markdown
Member

@pettinarip pettinarip commented May 20, 2026

Summary

  • Replace hand-maintained public/llms.txt with two force-static App Router routes that regenerate on every deploy from the existing nav files + content frontmatter.
  • Add ethereum.org/developers/docs/llms.txt as a docs-focused index (Next.js root-vs-docs split); root /llms.txt cross-links to it instead of inlining the deep docs tree.
  • Document the rendering strategy in docs/solutions/architecture/llms-txt-automation.md.

Links

Test plan

  • Open https://deploy-preview-<N>--ethereumorg.netlify.app/llms.txt and confirm sections mirror main nav (Learn / Use / Build / Participate / Research) + Legal & Policies, with ### More buckets for Footer-only items.
  • Open /developers/docs/llms.txt and confirm the full developer-docs sidebar renders as nested bullets.
  • Confirm the cross-link from the root file points at /developers/docs/llms.txt.
  • Confirm the Footer still renders identically on the homepage (its link data was extracted to a shared footerLinks.ts module).
  • Verify pretty URLs throughout (no /content/*/index.md links).

@pettinarip pettinarip requested a review from wackerow as a code owner May 20, 2026 13:06
@netlify
Copy link
Copy Markdown

netlify Bot commented May 20, 2026

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit b2bddf3
🔍 Latest deploy log https://app.netlify.com/projects/ethereumorg/deploys/6a170d033062ca00088323a2
😎 Deploy Preview https://deploy-preview-18234.ethereum.it
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 71 (🟢 up 6 from production)
Accessibility: 96 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (🔴 down 1 from production)
PWA: 59 (no change from production)
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 documentation 📖 Change or add documentation tooling 🔧 Changes related to tooling of the project labels May 20, 2026
@pettinarip
Copy link
Copy Markdown
Member Author

🤖 Heads up — this branch now conflicts with dev in src/components/Footer/index.tsx.

The conflict itself is mechanical (PR extracted the footer links into buildFooterLinkSections(t)/buildFooterDipperLinks(t); dev still edited the inline arrays), but there's a non-obvious catch: dev (commit 6d7409e "add /reports page under Research menu") changed the Research section, and that change did not make it into the extracted src/lib/nav/footerLinks.ts.

To resolve, take the PR's builder-function call site, then port dev's change into the Research links array in src/lib/nav/footerLinks.ts:

  • add { href: "/reports/", text: t("reports") }
  • change /trillion-dollar-security//reports/trillion-dollar-security/

Leaving this for a human since it touches src/lib/ and the fix lives in a file that isn't even part of the conflict (easy to silently drop).

# Conflicts:
#	src/components/Footer/index.tsx
@pettinarip
Copy link
Copy Markdown
Member Author

✅ Resolved the dev conflict and pushed b2bddf3.

  • Took the PR's builder-function call site in Footer/index.tsx.
  • Ported dev's Research-menu change into src/lib/nav/footerLinks.ts: added { href: "/reports/", text: t("reports") } and re-homed trillion-dollar-security under /reports/trillion-dollar-security/.

Local eslint clean on both touched files; reports translation key confirmed present. Netlify will rebuild the preview.

@pettinarip pettinarip merged commit b0ce19e into dev May 27, 2026
14 checks passed
@pettinarip pettinarip deleted the feat/llms-txt-automation branch May 27, 2026 16:24
@pettinarip pettinarip mentioned this pull request May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📖 Change or add documentation tooling 🔧 Changes related to tooling of the project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants