Merge branch 'main' into feature/#149-add-support-for-import-linter-to-lint-tasks

Author: Jannis-Mittenzwei

.github/workflows/gh-pages.yml

@@ -19,7 +19,7 @@ jobs:
           poetry run python -m nox -s build-docs
 
       - name: Deploy
-        uses: JamesIves/[email protected].0
+        uses: JamesIves/[email protected].3
         with:
           branch: gh-pages
           folder: .html-documentation

doc/changes/unreleased.md

@@ -17,3 +17,6 @@
 
 * #219: Updated project template configuration
 * Updated actions/checkout to v4
+
+## 📚 Documentation
+* Updated User Documentation

doc/user_guide/overview.rst

@@ -0,0 +1,18 @@
+Overview
+========
+
+Project Layout 
+--------------
+
+Overall, the toolbox generally expects a certain project layout because it tries to follow the credo "convention over configuration" when possible and reasonable. This expected structure can be better understood by looking at the cookie-cutter project template, which is part of the python-toolbox workspace and can be found in `project-template`. One can also generate a project from the template to explore the default structure. For more details on this, please check out the getting started section.
+
+Nox
+---
+
+The most central tool when interacting with the toolbox is :code:`nox`, which is the task runner used across all of Exasol's Python-based projects.
+The toolbox itself provides various standard tasks and a plugin mechanism to extend these tasks if needed. For more information regarding nox, please visit the `nox homepage <http://nox.thea.codes/en/stable/>`_.
+
+Central files in regards to nox and the toolbox are:
+
+- noxfile.py: Standard nox configuration/setup file
+- noxconfig.py: Exasol-specific file containing additional information needed by the standard tasks of the toolbox

doc/user_guide/user_guide.rst

@@ -6,6 +6,7 @@
 .. toctree::
     :maxdepth: 2
 
+    overview
     getting_started
     workflows
     customization