chore: minor updates regarding regression ci

.github/README.md

@@ -1,5 +1,9 @@
 <p align="center">
-<img width="144" height="144" src="https://img.icons8.com/pulsar-gradient/144/tree.png" alt="tree"/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" width="100" height="100" srcset="../docs/assets/logo-white.png">
+  <source media="(prefers-color-scheme: light)" width="100" height="100" srcset="../docs/assets/logo-dark.png">
+  <img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="../docs/assets/logo-dark.png">
+</picture>
 </p>
 
 <h1 align="center">Sylva identity discovery</h1>

.github/workflows/regression.yaml

@@ -57,7 +57,7 @@ jobs:
           '3.10',
           '3.11',
           '3.12',
-          '3.13',
+        #  '3.13',  Some dependencies are not yet compatible with 3.13
         ]
     steps:
       - uses: actions/checkout@v4

docs/assets/favicon.png

@@ -0,0 +1 @@
+logo-black.png

docs/assets/logo.png

@@ -0,0 +1 @@
+logo-white.png

docs/contributing/regression.md

@@ -0,0 +1,28 @@
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ppfeister/sylva/regression.yaml?branch=master&event=release&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAAAsTAAALEwEAmpwYAAABEklEQVR4nO2ZSw7CMAwFfWuW6bK3HsQCCUFaxf3Q2n6zRbV4IyuxWzMhhBD/B5iA2QqHfzNXDl9LAv3wNSSwHj63BMbC55SAL3wuCWwLn0MC+8LHloA/fAMeKSSwIfzHs7ElsCN8eAkceNqHk8AJp30oCSz/WUlwoE5AEtyd8HOLVDoTmiUfhaeVut3fbgXaBVxoFwg3/PTQLlBx+HmhXQDtAiYJJglXdMI9x2G0C5h2AbQLuNAuEHIC/Ea7gI/FKyxcJ3DAF6HQEvDd+8PDS0YJ7cC64SS0E+qGkdDuWvcURt/fL7XK3rq3gIH3914Bo3XDwAYBqUAC+lgVkIA+VgUkoI9VAQnoY1WgugAhhLCLeQK0o/Lg9gzSKwAAAABJRU5ErkJggg==&label=Release)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ppfeister/sylva/regression.yaml?branch=master&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAAAsTAAALEwEAmpwYAAABEklEQVR4nO2ZSw7CMAwFfWuW6bK3HsQCCUFaxf3Q2n6zRbV4IyuxWzMhhBD/B5iA2QqHfzNXDl9LAv3wNSSwHj63BMbC55SAL3wuCWwLn0MC+8LHloA/fAMeKSSwIfzHs7ElsCN8eAkceNqHk8AJp30oCSz/WUlwoE5AEtyd8HOLVDoTmiUfhaeVut3fbgXaBVxoFwg3/PTQLlBx+HmhXQDtAiYJJglXdMI9x2G0C5h2AbQLuNAuEHIC/Ea7gI/FKyxcJ3DAF6HQEvDd+8PDS0YJ7cC64SS0E+qGkdDuWvcURt/fL7XK3rq3gIH3914Bo3XDwAYBqUAC+lgVkIA+VgUkoI9VAQnoY1WgugAhhLCLeQK0o/Lg9gzSKwAAAABJRU5ErkJggg==&label=Head)
+
+
+
+Since projects like these contain many moving parts, we prefer to use regression testing to ensure that changes don't break existing functionality. Regression testing is built into our CI (build statuses are shown above), with tests occuring on both changes to `master` and the publication of new releases before their builds are pushed for distribution.
+
+Note that it's normal for the build status of `master` (at the HEAD of the branch) to be failing on occasion, due to the staged application of certain changes. **Most of the time** our CI will prevent these failed builds from replacing `preview` images, but we may override that on occasion.
+
+Contributors __SHOULD__ run the test suite locally before committing changes, to ensure that all bases are covered. The test suite can be fully self-contained in the pdm development environment, and can therefore be ran without any additional local dependencies.
+
+## Running unit tests
+
+Contributors that have installed the development environment via `pdm install -G:all` as described in the [Advanced Install][advanced-install]{target="_blank"} guide can run the test suite one of two ways:
+
+#### Within venv
+
+```bash
+tox
+```
+
+#### Outside of venv
+
+```bash
+pdm run tox
+```
+
+[advanced-install]: /install-adv/#installing-sylva-for-development

mkdocs.yml

@@ -138,4 +138,5 @@ nav:
   - Contributing:
     - Introduction: contributing/introduction.md
     - Documentation: contributing/documentation.md
+    - Regression Testing: contributing/regression.md
   - Sponsor: https://github.com/sponsors/ppfeister