Concepts

Why Quillet works the way it does: documents, versions, locales, components, environments, delivery, search, files and access.

• Why Quillet exists

  Quillet keeps your content out of your code, makes publishing an act of its own, lets a translation inherit what it does not say, and shows a draft on your real site before anyone else sees it.

• How the parts fit

  Quillet is one process that serves two APIs and the dashboard, and each of its clients (the dashboard, the CLI, the SDK and your site) reaches it with its own kind of credential.

• Documents, keys and folders

  A document is one locale of one piece of content in one environment, it is addressed by a slash-separated key such as docs/guides/intro, and a folder is nothing more than the shared start of the keys under it.

• Versions and publishing

  Every save in Quillet appends a version that never changes again, and publishing is a separate act that tells readers which of those versions to see.

• Locales and fallback

  A translation in Quillet holds only the fields it translates, and every field it leaves out is read from the project's default locale at the moment a reader asks for it.

• Components and pages

  A component is a JSON Schema stored as an ordinary document, a page is a document bound to a component marked as a page, and the dashboard's built-in preview draws either one from the roles its fields declare.

• Environments and promotion

  An environment is a complete, separate copy of a project's content, and promotion moves a set of changes you choose from one copy into another in a single transaction.

• Delivery

  Delivery is a second, read-only API under /d/v1 that serves only published content, from a cache, to whoever holds a delivery key for that one environment.

• Search

  Search lets a site ask one environment's published content a question in words and answers with the pages that match, the heading each match sits under, and a short plain-text snippet.

• Files and media

  A file in Quillet belongs to the whole project rather than to one environment, its bytes never change once uploaded, and it is public unless you mark it private.

• Access

  Quillet has four credentials (an account, a personal token, a CLI key and a delivery key), and each one reaches a different part of the system for a different reason.

• Integrating a site

  Your site learns that content changed in one of three ways: it asks again after a set time, Quillet tells it with a signed webhook, or you rebuild it.