chore(docs): annotate config.yaml with field descriptions

vst · Mar 28, 2024 · 7755e50 · 7755e50
1 parent 005ee4a
commit 7755e50
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/config.yaml b/config.yaml
@@ -1,6 +1,9 @@
 hosts:
-  - name: somehost
+  - ## Name of the host (required)
+    name: somehost
+    ## External URL for the host (optional)
     url: https://internal.documentation/hosts/somehost
+    ## List of tags for the host (optional)
     tags:
       - oranges
       - strawberries