Skip to content

Documentation policy

Product code and schemas define runtime behavior. Generated CLI help defines the exact command surface. This site explains and organizes those facts. Notebook provenance records the product commit used for published executable material.

Documentation distinguishes four levels:

  1. an interface exists;
  2. a local or fake path works;
  3. a real profile is configured;
  4. a live service call is verified.

A lower level must not be described as a higher one. This keeps quickstarts small without overstating what they prove.

Do not publish internal datasets, private hosts, credentials, raw conversation history, proprietary experiment output, or third-party content without a compatible license. Prefer minimal synthetic examples and link to primary sources.