Skip to content
Quicklify
Quicklify document

Quicklify Canonical File Contract v1.1

Required file structure and governance rules for Quicklify sites.

This document defines the required file structure and governance rules for all Quicklify sites.

All Quicklify sites store content and configuration in a small, explicit set of canonical files. These files are the only source of truth for site content, configuration, and reviewable publishing workflows.

Required Structure

sites/<slug>/
  site.json
  faq.json
  sponsors.json
  kb.txt
  ai_profile.json

Rules

  • No hidden state.
  • No runtime databases.
  • No automatic publishing.
  • All content and configuration changes occur through version control.
  • All production changes require explicit human approval.
  • AI configuration is stored in canonical files and follows the same approval and version control standards as all other site content.
  • Packaged outputs such as site builds and ebook deliverables should remain traceable to canonical source files.

Upgrade Standard

Engine updates must preserve canonical file compatibility and be testable in staging before production.

Breaking changes require documentation.

The canonical file structure may evolve intentionally, but changes must be explicit, versioned, and documented before adoption.

← Back to Home