From bd7cba420c3adaa9d3f65f6b2e5caba5d856c649 Mon Sep 17 00:00:00 2001 From: pietervdvn Date: Tue, 23 Feb 2021 19:43:35 +0100 Subject: [PATCH] Improve docs --- Customizations/JSON/LayoutConfigJson.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Customizations/JSON/LayoutConfigJson.ts b/Customizations/JSON/LayoutConfigJson.ts index 9f56ac426..7816ff63f 100644 --- a/Customizations/JSON/LayoutConfigJson.ts +++ b/Customizations/JSON/LayoutConfigJson.ts @@ -2,9 +2,16 @@ import {LayerConfigJson} from "./LayerConfigJson"; import {TagRenderingConfigJson} from "./TagRenderingConfigJson"; /** - * Defines what a JSON-segment defining a layout should look like. + * Defines the entire theme. + * + * A theme is the collection of the layers that are shown; the intro text, the icon, ... + * It more or less defines the entire experience. + * + * Most of the fields defined here are metadata about the theme, such as its name, description, supported languages, default starting location, ... + * + * The main chunk of the json will however be the 'layers'-array, where the details of your layers are. * - * General remark: a type (string | any) indicates either a fixed or a translatable string + * General remark: a type (string | any) indicates either a fixed or a translatable string. */ export interface LayoutConfigJson { /**