Skip to content

Improve AI docs discoverability + canonicalize AI artifact origin#648

Merged
rossgalloway merged 4 commits intomasterfrom
Improve-AI-docs
Feb 25, 2026
Merged

Improve AI docs discoverability + canonicalize AI artifact origin#648
rossgalloway merged 4 commits intomasterfrom
Improve-AI-docs

Conversation

@rossgalloway
Copy link
Collaborator

Summary
This PR improves how users and agents discover Yearn’s AI-readable docs resources and ensures generated artifact metadata is canonical by default.

What changed

  • Added a new docs page at /getting-started/llm-friendly-docs:
    • Canonical AI endpoints (/llms.txt, /ai/manifest.json, /ai/docs.jsonl, /ai/raw/)
    • Example prompt for LLM use
    • Install instructions for both Codex and Claude Code for the yearn-docs-site-query skill
  • Added LLM Friendly Documentation links in all sidebars:
    • User docs: directly under FAQ
    • Dev docs: above Deprecated Products
    • DAO docs: bottom of sidebar
  • Updated scripts/generateAiArtifacts.ts:
    • siteOrigin now defaults to https://docs.yearn.fi
    • no longer auto-uses VERCEL_URL
    • still supports explicit override via DOCS_URL
  • Updated README AI exports section to document DOCS_URL override behavior.
  • Includes a timestamp refresh in scripts/fetchedAddressData.json (timeLastChecked).

Why

  • Prevents /llms.txt and AI manifest from unintentionally pointing to preview hosts.
  • Makes the AI/LLM entry points easy to find for users across docs sections.
  • Gives copy/paste install paths for the hosted docs skill in both Codex and Claude Code.

Validation

  • bun run build passes successfully.
  • New route is generated: build/getting-started/llm-friendly-docs/index.html.
  • Sidebar placements verified in all three sidebar configs.

@rossgalloway rossgalloway requested a review from engn33r February 24, 2026 18:47
@vercel
Copy link

vercel bot commented Feb 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
yearn-docs Ready Ready Preview, Comment Feb 24, 2026 9:51pm

Request Review

Copy link
Collaborator

@engn33r engn33r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@rossgalloway rossgalloway merged commit 488e6e9 into master Feb 25, 2026
5 checks passed
@rossgalloway rossgalloway deleted the Improve-AI-docs branch February 25, 2026 01:43
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