add comprehensive CLI documentation

.github/workflows/preview-docs.yml

@@ -0,0 +1,34 @@
+name: preview docs
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+  workflow_dispatch:
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v4
+        with:
+            python-version: 3.x
+
+      - name: Install and Build
+        if: github.event.action != 'closed' # You might want to skip the build if the PR has been closed
+        run: |
+          python -m pip install -e ".[docs]"
+          mkdocs build
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site/

.gitignore

@@ -34,3 +34,4 @@ vetiver-testing/rsconnect_api_keys.json
 
 # license files should not be commited to this repository
 *.lic
+/site/