Skip to content

Add multi-layer agent discovery metadata to veralang.dev#412

Merged
aallan merged 1 commit into
mainfrom
feat/agent-discovery-metadata
Mar 28, 2026
Merged

Add multi-layer agent discovery metadata to veralang.dev#412
aallan merged 1 commit into
mainfrom
feat/agent-discovery-metadata

Conversation

@aallan

@aallan aallan commented Mar 28, 2026

Copy link
Copy Markdown
Owner

Closes #400.

Agents don't press buttons — they discover resources through <head> metadata, structured data, and well-known conventions. This PR adds four layers of machine-readable hints so agents visiting veralang.dev can find SKILL.md without visual parsing.

Changes (priority order from #400)

1. <head> link elements

  • rel="alternate" type="text/markdown" href=SKILL.md — standard HTML, broad compatibility
  • rel="llms-txt" and rel="llms-full-txt" — Mintlify convention, gaining adoption

2. <script type="text/llms.txt"> inline block

Invisible to browsers (unrecognised MIME type → no execution). Immediately discoverable by any agent parsing the DOM for agent-directed content. No separate fetch required. Follows Vercel's proposal.

3. HTTP headers

Skipped — GitHub Pages does not support custom response headers.

4. JSON-LD structured data

Two new TechArticle entries added to the existing @graph: SKILL.md and AGENTS.md, each with encodingFormat: "text/markdown", audience.audienceType: "AI agents and LLMs", and isPartOf linking back to veralang.dev.

5. CTA button semantic attributes

rel="agent-instructions", type="text/markdown", data-agent-role="skill", data-agent-description added to the existing "For Agents → SKILL.md" anchor. Symbolic but costs nothing.

Validation

  • python scripts/check_html_examples.py — all 5 Vera code blocks still pass
  • python scripts/check_site_assets.py — site assets up-to-date
  • python scripts/check_doc_counts.py — counts consistent

🤖 Generated with Claude Code

Four layers of machine-readable hints so agents can find SKILL.md without
visual parsing, following priority order from #400:

1. <head> link elements
   - rel="alternate" type="text/markdown" href=SKILL.md (standard HTML)
   - rel="llms-txt" and rel="llms-full-txt" (Mintlify convention)

2. <script type="text/llms.txt"> inline block (Vercel convention)
   Invisible to browsers; immediately discoverable by DOM-parsing agents.
   Lists SKILL.md, AGENTS.md, llms.txt, llms-full.txt with descriptions.

3. HTTP headers — skipped; GitHub Pages does not support custom headers.

4. JSON-LD structured data
   Two new TechArticle entries in the existing @graph: SKILL.md and
   AGENTS.md, each with encodingFormat, audience, and isPartOf.

5. CTA button semantic attributes
   rel="agent-instructions", type="text/markdown", data-agent-role,
   data-agent-description on the existing "For Agents → SKILL.md" anchor.

Co-Authored-By: Claude <noreply@anthropic.invalid>
@coderabbitai

coderabbitai Bot commented Mar 28, 2026

Copy link
Copy Markdown

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • docs/index.html is excluded by !docs/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: bed50670-183e-4ea1-8ab6-c40e582c7a86

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/agent-discovery-metadata

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Mar 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.30%. Comparing base (8ef7e5f) to head (3702ab5).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #412   +/-   ##
=======================================
  Coverage   90.30%   90.30%           
=======================================
  Files          49       49           
  Lines       19105    19105           
  Branches      220      220           
=======================================
  Hits        17253    17253           
  Misses       1848     1848           
  Partials        4        4           
Flag Coverage Δ
javascript 50.58% <ø> (ø)
python 95.31% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aallan aallan merged commit 177e88e into main Mar 28, 2026
17 checks passed
@aallan aallan deleted the feat/agent-discovery-metadata branch March 28, 2026 21:02
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.

Move 'For Agents' section above the fold in docs/index.html

1 participant