Record

document

A single documentation entry.

record document {
  id: string,
  title: string,
  language: string,
  format: format,
  contents: string,
}

Fields

NameTypeDescription
idstringStable, URL-safe identifier (e.g. "readme", "guides/auth").
titlestringHuman-readable title.
languagestringBCP-47 language tag (e.g. "en", "ja"). Empty if unknown.
formatformatMarkup format of contents.
contentsstringThe raw document body.