sartography · burnettk · Jun 11, 2026 · Jun 3, 2026 · Jun 3, 2026 · Jun 11, 2026
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,12 +5,12 @@ on:
     branches:
       - main
     paths:
-      - 'doc/**'
+      - 'docs/**'
   pull_request:
     branches:
       - main
     paths:
-      - 'doc/**'
+      - 'docs/**'
 
 # Security: restrict GITHUB_TOKEN to least privilege.
 # See: https://www.upwind.io/feed/hackerbot-claw-github-actions-pull-request-rce
@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: doc
+        working-directory: docs
     steps:
       - name: Check out the repository
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4
@@ -48,7 +48,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: docs-html
-          path: doc/_build/html/
+          path: docs/_build/html/
 
   sync-to-website:
     name: sync-docs-to-website

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -6,7 +6,7 @@ build:
     python: "3.12"
 
 sphinx:
-  configuration: doc/conf.py
+  configuration: docs/conf.py
 
 python:
   install:

diff --git a/CONTRIB b/CONTRIB
@@ -51,10 +51,10 @@ Licensing:
 ## Releases
 For you dev op folks who release builds to the larger community ...
 
-Update the release tag: doc/conf.py
+Update the release tag: docs/conf.py
 And also edit setup.py and assure that has the same release tag.
 New versions of SpiffWorkflow are automatically published to PyPi whenever
 a maintainer of our GitHub repository creates a new release on  GitHub.  This
 is managed through GitHub's actions.  The configuration of which can be
 found in .github/workflows/....
-Just create a release in GitHub that matches the release number in doc/conf.py
+Just create a release in GitHub that matches the release number in docs/conf.py
diff --git a/Makefile b/Makefile
@@ -13,15 +13,15 @@ clean:
 	find . -name "*.pyc" -o -name "*.pyo" | xargs -rn1 rm -f
 	find . -name "*.egg-info" | xargs -rn1 rm -r
 	rm -Rf build
-	cd doc; make clean
+	cd docs; make clean
 
 .PHONY : dist-clean
 dist-clean: clean
 	rm -Rf dist
 
 .PHONY : doc
 doc:
-	cd doc; make html
+	cd docs; make html
 
 .PHONY : tests
 tests:

diff --git a/doc/.gitignore → docs/.gitignore b/doc/.gitignore → docs/.gitignore
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/_themes/spiffworks/globaltoc.html → docs/_themes/spiffworks/globaltoc.html b/doc/_themes/spiffworks/globaltoc.html → docs/_themes/spiffworks/globaltoc.html
diff --git a/doc/_themes/spiffworks/layout.html → docs/_themes/spiffworks/layout.html b/doc/_themes/spiffworks/layout.html → docs/_themes/spiffworks/layout.html
diff --git a/doc/_themes/spiffworks/static/spiffworks.css → .../_themes/spiffworks/static/spiffworks.css b/doc/_themes/spiffworks/static/spiffworks.css → .../_themes/spiffworks/static/spiffworks.css
diff --git a/doc/_themes/spiffworks/theme.conf → docs/_themes/spiffworks/theme.conf b/doc/_themes/spiffworks/theme.conf → docs/_themes/spiffworks/theme.conf
diff --git a/doc/bin/serve_docs → docs/bin/serve_docs b/doc/bin/serve_docs → docs/bin/serve_docs
@@ -8,23 +8,23 @@ PORT="${PORT:-8001}"
 case "${1:-}" in
   -h|--help|help)
     cat <<EOF
-Usage: doc/bin/serve_docs
+Usage: docs/bin/serve_docs
 
 Environment:
   HOST  Bind host, default 127.0.0.1
   PORT  Bind port, default 8001
 
 Examples:
-  doc/bin/serve_docs
-  PORT=8010 doc/bin/serve_docs
+  docs/bin/serve_docs
+  PORT=8010 docs/bin/serve_docs
 EOF
     exit 0
     ;;
   "")
     ;;
   *)
     echo "Unknown argument: $1" >&2
-    echo "Usage: doc/bin/serve_docs" >&2
+    echo "Usage: docs/bin/serve_docs" >&2
     exit 1
     ;;
 esac

diff --git a/doc/bpmn/application.rst → docs/bpmn/application.rst b/doc/bpmn/application.rst → docs/bpmn/application.rst
diff --git a/...n/camunda/figures/call_activity_multi.png → ...n/camunda/figures/call_activity_multi.png b/...n/camunda/figures/call_activity_multi.png → ...n/camunda/figures/call_activity_multi.png
diff --git a/doc/bpmn/camunda/figures/documentation.png → docs/bpmn/camunda/figures/documentation.png b/doc/bpmn/camunda/figures/documentation.png → docs/bpmn/camunda/figures/documentation.png
diff --git a/...n/camunda/figures/documentation_multi.png → ...n/camunda/figures/documentation_multi.png b/...n/camunda/figures/documentation_multi.png → ...n/camunda/figures/documentation_multi.png
diff --git a/...n/camunda/figures/message_start_event.png → ...n/camunda/figures/message_start_event.png b/...n/camunda/figures/message_start_event.png → ...n/camunda/figures/message_start_event.png
diff --git a/...ures/multiinstance_task_configuration.png → ...ures/multiinstance_task_configuration.png b/...ures/multiinstance_task_configuration.png → ...ures/multiinstance_task_configuration.png
diff --git a/...n/camunda/figures/throw_message_event.png → ...n/camunda/figures/throw_message_event.png b/...n/camunda/figures/throw_message_event.png → ...n/camunda/figures/throw_message_event.png
diff --git a/doc/bpmn/camunda/figures/user_task.png → docs/bpmn/camunda/figures/user_task.png b/doc/bpmn/camunda/figures/user_task.png → docs/bpmn/camunda/figures/user_task.png
diff --git a/doc/bpmn/camunda/index.rst → docs/bpmn/camunda/index.rst b/doc/bpmn/camunda/index.rst → docs/bpmn/camunda/index.rst
diff --git a/doc/bpmn/custom_task_spec.rst → docs/bpmn/custom_task_spec.rst b/doc/bpmn/custom_task_spec.rst → docs/bpmn/custom_task_spec.rst
diff --git a/doc/bpmn/data.rst → docs/bpmn/data.rst b/doc/bpmn/data.rst → docs/bpmn/data.rst
diff --git a/doc/bpmn/diffs.rst → docs/bpmn/diffs.rst b/doc/bpmn/diffs.rst → docs/bpmn/diffs.rst
diff --git a/doc/bpmn/errors.rst → docs/bpmn/errors.rst b/doc/bpmn/errors.rst → docs/bpmn/errors.rst
diff --git a/doc/bpmn/imports.rst → docs/bpmn/imports.rst b/doc/bpmn/imports.rst → docs/bpmn/imports.rst
diff --git a/doc/bpmn/index.rst → docs/bpmn/index.rst b/doc/bpmn/index.rst → docs/bpmn/index.rst
diff --git a/doc/bpmn/logging.rst → docs/bpmn/logging.rst b/doc/bpmn/logging.rst → docs/bpmn/logging.rst
diff --git a/doc/bpmn/parsing.rst → docs/bpmn/parsing.rst b/doc/bpmn/parsing.rst → docs/bpmn/parsing.rst
diff --git a/doc/bpmn/script_engine.rst → docs/bpmn/script_engine.rst b/doc/bpmn/script_engine.rst → docs/bpmn/script_engine.rst
diff --git a/doc/bpmn/serialization.rst → docs/bpmn/serialization.rst b/doc/bpmn/serialization.rst → docs/bpmn/serialization.rst
diff --git a/doc/bpmn/supported.rst → docs/bpmn/supported.rst b/doc/bpmn/supported.rst → docs/bpmn/supported.rst
diff --git a/doc/bpmn/workflows.rst → docs/bpmn/workflows.rst b/doc/bpmn/workflows.rst → docs/bpmn/workflows.rst
diff --git a/doc/concepts.rst → docs/concepts.rst b/doc/concepts.rst → docs/concepts.rst
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/core/custom-tasks/index.rst → docs/core/custom-tasks/index.rst b/doc/core/custom-tasks/index.rst → docs/core/custom-tasks/index.rst
diff --git a/doc/core/custom-tasks/nuclear.json → docs/core/custom-tasks/nuclear.json b/doc/core/custom-tasks/nuclear.json → docs/core/custom-tasks/nuclear.json
diff --git a/doc/core/custom-tasks/serializer.py → docs/core/custom-tasks/serializer.py b/doc/core/custom-tasks/serializer.py → docs/core/custom-tasks/serializer.py
diff --git a/doc/core/custom-tasks/start.py → docs/core/custom-tasks/start.py b/doc/core/custom-tasks/start.py → docs/core/custom-tasks/start.py
diff --git a/doc/core/custom-tasks/strike.py → docs/core/custom-tasks/strike.py b/doc/core/custom-tasks/strike.py → docs/core/custom-tasks/strike.py
diff --git a/doc/core/index.rst → docs/core/index.rst b/doc/core/index.rst → docs/core/index.rst
diff --git a/doc/core/patterns.rst → docs/core/patterns.rst b/doc/core/patterns.rst → docs/core/patterns.rst
diff --git a/doc/core/tutorial/deserialize-wf.py → docs/core/tutorial/deserialize-wf.py b/doc/core/tutorial/deserialize-wf.py → docs/core/tutorial/deserialize-wf.py
diff --git a/doc/core/tutorial/deserialize.py → docs/core/tutorial/deserialize.py b/doc/core/tutorial/deserialize.py → docs/core/tutorial/deserialize.py
diff --git a/doc/core/tutorial/index.rst → docs/core/tutorial/index.rst b/doc/core/tutorial/index.rst → docs/core/tutorial/index.rst
diff --git a/doc/core/tutorial/nuclear.json → docs/core/tutorial/nuclear.json b/doc/core/tutorial/nuclear.json → docs/core/tutorial/nuclear.json
diff --git a/doc/core/tutorial/nuclear.py → docs/core/tutorial/nuclear.py b/doc/core/tutorial/nuclear.py → docs/core/tutorial/nuclear.py
diff --git a/doc/core/tutorial/serialize-wf.py → docs/core/tutorial/serialize-wf.py b/doc/core/tutorial/serialize-wf.py → docs/core/tutorial/serialize-wf.py
diff --git a/doc/core/tutorial/serialize.py → docs/core/tutorial/serialize.py b/doc/core/tutorial/serialize.py → docs/core/tutorial/serialize.py
diff --git a/doc/core/tutorial/start.py → docs/core/tutorial/start.py b/doc/core/tutorial/start.py → docs/core/tutorial/start.py
diff --git a/doc/favicon.ico → docs/favicon.ico b/doc/favicon.ico → docs/favicon.ico
diff --git a/doc/figures/action-management.png → docs/figures/action-management.png b/doc/figures/action-management.png → docs/figures/action-management.png
diff --git a/doc/figures/classes.png → docs/figures/classes.png b/doc/figures/classes.png → docs/figures/classes.png
diff --git a/doc/figures/interaction.png → docs/figures/interaction.png b/doc/figures/interaction.png → docs/figures/interaction.png
diff --git a/doc/figures/nuclear_strike.bpmn → docs/figures/nuclear_strike.bpmn b/doc/figures/nuclear_strike.bpmn → docs/figures/nuclear_strike.bpmn
diff --git a/doc/figures/state-diagram.png → docs/figures/state-diagram.png b/doc/figures/state-diagram.png → docs/figures/state-diagram.png
diff --git a/doc/figures/state-diagram.svg → docs/figures/state-diagram.svg b/doc/figures/state-diagram.svg → docs/figures/state-diagram.svg
diff --git a/doc/images/logo.png → docs/images/logo.png b/doc/images/logo.png → docs/images/logo.png
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/doc/modules.rst → docs/modules.rst b/doc/modules.rst → docs/modules.rst
diff --git a/tests/SpiffWorkflow/core/docTest.py b/tests/SpiffWorkflow/core/docTest.py
@@ -5,7 +5,7 @@
 
 dirname = os.path.abspath(os.path.dirname(__file__))
 sys.path.insert(0, os.path.join(dirname, '..', '..', '..'))
-doc_dir = os.path.join(dirname, '..', '..', '..', 'doc')
+doc_dir = os.path.join(dirname, '..', '..', '..', 'docs')
 
 
 class TutorialTest: