To be cleaned up

.github/workflows/docs.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
   build:
@@ -18,8 +19,6 @@ jobs:
         # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CUSTOM_DOMAIN: optionaldomain.com
-          CONFIG_FILE: folder/mkdocs.yml
           EXTRA_PACKAGES: build-base
           # GITHUB_DOMAIN: github.myenterprise.com
           REQUIREMENTS: folder/requirements.txt

docs/explanation.md

@@ -248,3 +248,7 @@ from the check for unused imports, you can use the `--ignore-unused` option
 to customize the ignore list. By providing your own list of dependencies with
 this option, you can effectively overwrite the default list. For example:
 `--ignore-unused black mypy some_other_module`
+
+## History
+[Design Document](./DesignDoc.md)
+[Code Design](./CodeDesign.md)

mkdocs.yml

@@ -5,9 +5,10 @@ repo_name: tweag/FawltyDeps
 
 theme: 
   name: material 
-  logo: images/tweag_mini_logo.png
+  favicon: material/check-circle
   icon:
     repo: fontawesome/brands/github
+    logo: material/check-circle
   hjls_language:
     - python
     - yaml
@@ -38,7 +39,10 @@ nav:
 
   - Home: index.md
   - Installation: installation.md
-  - Explanation: explanation.md
+  - How it works:
+    - Explanation: explanation.md
+    - Design Document: DesignDoc.md
+    - Code Design: CodeDesign.md
   - Reference: reference.md
   - How To Guides: how_to_guides.md
   - FAQ: FAQ.md