Start some basic documentation

osmus · Apr 22, 2024 · 82ed672 · 82ed672
1 parent 8cc473e
commit 82ed672
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 5 deletions.
diff --git 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
@@ -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": [