From e7e2c2c69ceabe41090a0dd2586a99428c239af6 Mon Sep 17 00:00:00 2001
From: "William F. Broderick" <billbrod@gmail.com>
Date: Wed, 25 Sep 2024 14:27:41 -0400
Subject: [PATCH] Updates files

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ae4f2bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# plenoptic-docs
+
+> [!CAUTION]
+> This repo should not be edited manually.
+
+Built workshop materials for the plenoptic package. Note that this repository
+just contains the *built* documentation for the package, the source of the
+documentation lies in other repos from the [plenoptic
+organization](https://github.com/plenoptic-org) (generally those with "workshop"
+in the title).
+
+We use this repo essentially as a webserver: the html is placed here and then
+hosted on github pages, and we treat this repo as "shallow", not tracking the
+history. The building and pushing is all handled by Jenkins jobs triggered in
+the main repo.
+
+## How to delete history every push
+
+> [!CAUTION]
+> In general, this is an exceedingly bad idea. We do this here because we don't care about our git history **at all**.
+
+In order to keep the git history at a single commit, we remove `.git` and re-initialize it every time:
+
+``` sh
+rm -rf .git
+git init
+git remote add origin git@github.com:plenoptic-org/plenoptic-workshops.git
+git add .
+git commit -m "Updates files"
+git push -f origin main
+```