From bd38e15e7b2ec0b993030cd0cfe27f1c50a6da3f Mon Sep 17 00:00:00 2001
From: Rob Arnold <326113+robarnold@users.noreply.github.com>
Date: Wed, 11 Oct 2023 06:27:55 -0700
Subject: [PATCH] Add docs for zsh role

---
 ansible/roles/zsh/defaults/main.yml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/ansible/roles/zsh/defaults/main.yml b/ansible/roles/zsh/defaults/main.yml
index 208fd647..80099734 100644
--- a/ansible/roles/zsh/defaults/main.yml
+++ b/ansible/roles/zsh/defaults/main.yml
@@ -1,3 +1,9 @@
+# User to install configs for. This can drive the other variables or be ignored in favor of directly setting them all
+zsh__user: ""
+
+# Config path to install the zsh configs to
 zsh__config_path: "/home/{{ zsh__user }}"
+
+# Ownership information for the configs on the path
 zsh__config_owner: "{{ zsh__user }}"
 zsh__config_group: "{{ zsh__user }}"