Skip to content

Add agent documentation discovery endpoints#1931

Merged
Th0rgal merged 2 commits into
mainfrom
agent-docs-discovery
May 23, 2026
Merged

Add agent documentation discovery endpoints#1931
Th0rgal merged 2 commits into
mainfrom
agent-docs-discovery

Conversation

@Th0rgal
Copy link
Copy Markdown
Member

@Th0rgal Th0rgal commented May 23, 2026

Summary

  • add standard agent discovery headers and well-known rewrites for llms.txt, full docs markdown, and the Verity agent workflow
  • expose /llms-full.txt and /.well-known/llms-full.txt backed by the existing concatenated docs API
  • add /skill.md plus /.well-known/agent-skills for operational agent guidance when editing Verity contracts and proofs
  • refactor docs markdown reading/indexing into shared server helpers used by both single-page and full-doc endpoints
  • support Accept: text/plain as a markdown negotiation fallback while preserving existing .md, ?format=md, and AI user-agent behavior

Verification

  • npm run build in docs-site
  • local HTTP probes for:
    • /architecture.md
    • /compiler with Accept: text/plain
    • /.well-known/llms-full.txt
    • /.well-known/skill.md
    • /.well-known/agent-skills

Note

Medium Risk
Adds new public endpoints/rewrites and injects agent discovery headers site-wide, which could affect caching/routing behavior and response headers for all requests.

Overview
Adds agent discovery support to the docs site: new /llms-full.txt, /skill.md, and /.well-known/* aliases plus a JSON /.well-known/agent-skills index, and advertises these via Link/X-* discovery headers on all routes.

Refactors the docs markdown API to use shared server utilities (server/docs.ts) for indexing, frontmatter parsing, single-doc reads, and full-doc concatenation, and updates the proxy to also negotiate markdown on Accept: text/plain while ensuring discovery headers are applied to both rewrites and normal responses.

Reviewed by Cursor Bugbot for commit 98c951e. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

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

Project Deployment Actions Updated (UTC)
verity Ready Ready Preview, Comment May 23, 2026 3:59am

Request Review

@Th0rgal Th0rgal merged commit bc3c838 into main May 23, 2026
2 checks passed
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.

1 participant