Improved dev notes.

eseckel · Jan 17, 2024 · 7448640 · 7448640
1 parent 4f43aeb
commit 7448640
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/_dev_readme.txt → docs/_dev_notes.md b/docs/_dev_readme.txt → docs/_dev_notes.md
@@ -1,5 +1,12 @@
 # How to build/update the website
 
+## Notes
+- You should not have to use this on a regular basis. The repository is setup to
+run the validation for each pull request and the deployment whenever you accept
+a pull request or push a commit directly to the main branch. You should use this
+to test changes locally.
+- Your repository should be setup to serve pages from the gh-pages branch.
+
 ## Requirements
 - Python
 - Git