Augeo AI Docs
Augeo Design SystemAgent Consumers

Agent Feed

Machine-readable contracts for the design-agent and other agentic consumers.

The Augeo Design System exposes structured metadata designed for AI-driven consumers — the design-agent in augeo-ai-server, variant generators, lint/audit agents, and any future tooling that needs to reason about the system without reading MDX.

The agent feed is the canonical README frontmatter colocated with each component. Registry JSON is internal tooling only and is not part of the public package surface.

Canonical source: README frontmatter

Every meaningful design-system item has a colocated README.md whose YAML frontmatter validates against a Zod schema. This is the single source of truth — the design-agent crawls these directly without going through any intermediate artifact.

ItemPath
Augeo component READMEsrc/components/ui/<slug>/README.md
Schemasrc/metadata/readme-frontmatter.schema.ts
Standarddocs/standards/authoring-components.md

Frontmatter shape:

name: StatTile
type: atom
description: One sentence. What it is, in under 280 characters.
figma: []
interaction_states: {}

Agents read the schema and validate the frontmatter at consumption time. They never auto-select a component whose export carries @deprecated.

Published artifacts

The public package exposes only the main JavaScript entry and the compiled stylesheet:

ExportPurpose
@kigo-digital/design-systemReact components, types, ThemeProvider, baseTheme, augeoTheme, useTheme, and DesignSystemTheme
@kigo-digital/design-system/styles.cssPrecompiled Augeo defaults plus the augds- prefixed utility rules used by components

Token JSON, partner CSS, and Tailwind presets are internal build/source artifacts. Agents that need component metadata should read the source READMEs and validate them against src/metadata/readme-frontmatter.schema.ts (bun run ds-readme:validate).

Source of truth

The per-component README is the contract. Registry files in the repository are internal tooling inputs and must not be treated as public package artifacts.

Versioning

The public package versions the component implementations, README metadata, and stylesheet together. Pin to a specific version (e.g., @kigo-digital/design-system@0.5.1) and bump deliberately. Each release is immutable.