Machine-Readable Resources & llms.txt

As technical knowledge consumption shifts toward AI search engines (Perplexity, ChatGPT Search, Claude, Gemini), traditional HTML web scraping often introduces noise from banners, navigation menus, and client-side rendering.

ZyVOP provides clean article resources and the community-proposed llms.txt format for compatible agents that choose to use them.

Machine-Readable EndpointsCopy Anchor Link

ZyVOP exposes three primary discovery surfaces for AI agents:

graph TD
    AIAgent[AI Search Engine / LLM Crawler] --> Index[/llms.txt\nCurated Overview & Fresh Articles]
    AIAgent --> FullCatalog[/llms-full.txt\nFull Index up to 500 Canonical Posts]
    AIAgent --> GEOAPI[/api/geo/posts/{slug}\nClean JSON Document Representation]

1. /llms.txtCopy Anchor Link

A clean, plain-text Markdown file served at the root of your ZyVOP instance:

• Site Overview: Summary of the platform, topic areas, and author roster.
• Canonical and Timestamp Context: Canonical article links and update timestamps that compatible consumers may choose to use.
• Top Canonical Articles: Direct links to recent canonical articles paired with their machine-readable JSON counterparts.

2. /llms-full.txtCopy Anchor Link

An expanded catalog containing up to 500 canonical technical articles, complete with author bylines, publication timestamps, topic tags, and concise abstract excerpts.

3. Machine-Readable GEO API (/api/geo/posts/{slug})Copy Anchor Link

For every published canonical article, ZyVOP automatically serves a clean JSON representation:

GET /api/geo/posts/postgres-zero-downtime HTTP/1.1
Host: zyvop.com
Accept: application/json

Example PayloadCopy Anchor Link

{
  "slug": "postgres-zero-downtime",
  "title": "Zero-Downtime Database Migrations with PostgreSQL",
  "canonicalUrl": "https://zyvop.com/alex/postgres-zero-downtime",
  "author": {
    "name": "Alex Mercer",
    "username": "alex",
    "isTrustedAuthor": true
  },
  "publishedAt": "2026-09-15T10:00:00Z",
  "updatedAt": "2026-09-20T14:30:00Z",
  "topicSignals": ["postgresql", "database", "migrations", "devops"],
  "headings": [
    { "level": 2, "text": "Understanding Table Locks in Postgres" },
    { "level": 2, "text": "The Expand-Contract Pattern" },
    { "level": 3, "text": "Step 1: Adding Columns Concurrently" },
    { "level": 3, "text": "Step 2: Backfilling in Batches" }
  ],
  "outboundReferences": [
    "https://www.postgresql.org/docs/current/explicit-locking.html"
  ],
  "contentHash": "sha256-8f4b23...",
  "plainTextContent": "Zero-Downtime Database Migrations with PostgreSQL\n\nWhen altering tables with millions of rows..."
}

Best Practices for AuthorsCopy Anchor Link

To improve the clarity and machine readability of your article:

1. Use Explicit Canonical URLs: Canonicals identify your preferred source, though crawlers make their own selection.
2. Include Clear Technical Headings: ZyVOP exposes the H2/H3 hierarchy in machine-readable article resources.
3. Provide Accurate Excerpts: Frontmatter excerpt or subtitle fields provide summary metadata, although search services may generate their own snippets.
4. Cite Outbound Sources When Needed: Authoritative links help readers verify factual and time-sensitive claims.