Skip to content

Canonical documentation

Build with CodeY CMS without guessing.

Use these contracts for installation, generation, extension development, and production operation. AI agents and developers follow the same versioned rules.

Generation contract WebsiteSpec 1.0

Installed agents discover the exact runtime registry through GET /api/v1/config/generation/contract

Generate

WebsiteSpec and builder registry

Map content into strict pages, sections, media, products, and generator-safe elements. Validate, dry-run, and atomically apply the same payload.

Generation contract

Install

Signed stable self-hosting

Use the packaged launcher and Docker path. New installations select the latest signed stable runtime without asking nontechnical users to choose a version.

Installation guide

Integrate

API and MCP discovery

Use the authenticated API for installed sites. Use the public read-only MCP connector for product discovery, fit evaluation, install planning, and WebsiteSpec validation.

Agent integration

Extend

Content models and extensions

Create declarative collections and checksum-verified extension packs without executing unreviewed third-party server code or deleting customer content.

Extension guide

Operate

Security and recovery

Review authentication, proxy trust, provider credentials, storage, encrypted backups, monitoring, updates, and incident response before production launch.

Security checklist

Verify

Truthful acceptance

Server-rendered content, links, forms, carts, checkout, email, and recovery journeys are claimed only after their required runtime and browser checks pass.

Contribution workflow