Documentation structure for LLMs (llms.txt)

Page attributes

Every page starts with attributes that set its metadata. Start new pages from a template in the content templates, which include them.

= Page Title
:page-platform: Cloud, Server
:page-audience: developer
:page-description: A brief description for SEO and metadata (70-160 characters)
:experimental:
  • :page-platform: is the platform that supports the feature: Cloud, Server, or Cloud, Server.

  • :page-audience: is admin for Server operators, and developer for everyone else. Use both, comma-separated, when a page serves both audiences, for example developer, admin.

  • :page-description: is a clear summary of the page, between 70 and 160 characters. It must be unique across the site.

  • :experimental: enables the experimental AsciiDoc macros.

Other attributes are optional, such as :page-server-min-version:, :page-plan:, :page-vcs:, and :page-badge:. The check-metadata job in CI validates every page against schemas/docs-metadata.schema.json. Run the same check locally with npm run check:metadata.