From 82ed6729055eeb423013294cced8a772a86e3358 Mon Sep 17 00:00:00 2001 From: Quincy Morgan <2046746+quincylvania@users.noreply.github.com> Date: Mon, 22 Apr 2024 16:16:14 -0400 Subject: [PATCH] Start some basic documentation --- .../schemas/person.schema.json | 16 ++++++++++++++-- .../schemas/redirect.schema.json | 19 ++++++++++++++++--- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/_tools/frontmatter-validator/schemas/person.schema.json b/_tools/frontmatter-validator/schemas/person.schema.json index 44bbbd5..34b0151 100644 --- a/_tools/frontmatter-validator/schemas/person.schema.json +++ b/_tools/frontmatter-validator/schemas/person.schema.json @@ -5,10 +5,22 @@ "type": "object", "properties": { "title": { - "type": "string" + "type": "string", + "description": "The person's full display name or designation.", + "examples": [ + "Darla Dogson", + "Darla", + "darla_dog_1985" + ] }, "pronouns": { - "type": "string" + "type": "string", + "description": "The person's pronouns.", + "examples": [ + "she/her", + "they/them", + "he/they" + ] }, "updated": { "type": "string", diff --git a/_tools/frontmatter-validator/schemas/redirect.schema.json b/_tools/frontmatter-validator/schemas/redirect.schema.json index 5b1d7cd..8c51d00 100644 --- a/_tools/frontmatter-validator/schemas/redirect.schema.json +++ b/_tools/frontmatter-validator/schemas/redirect.schema.json @@ -5,13 +5,26 @@ "type": "object", "properties": { "permalink": { - "type": "string" + "type": "string", + "description": "The relative URL of the referring page.", + "examples": [ + "/schedule" + ] }, "redirect": { - "type": "string" + "type": "string", + "description": "The relative or absolute URL of the destination page.", + "examples": [ + "/program", + "https://example.com/program" + ] }, "title": { - "type": "string" + "type": "string", + "description": "A title for this link for use in internal labeling (usually not needed).", + "examples": [ + "Program" + ] } }, "required": [