From 8977ece728815a8410ef6540e48f0b8ce14a8e3f Mon Sep 17 00:00:00 2001
From: L483 <55800398+L483@users.noreply.github.com>
Date: Sat, 19 Oct 2024 16:13:42 +0200
Subject: [PATCH] ci(dartdoc): install dependencies in workflow

---
 .github/workflows/dartdoc.yml | 1 +
 docs/categories/globals.md    | 4 ++++
 docs/categories/others.md     | 3 +++
 docs/categories/screens.md    | 6 ++++++
 docs/categories/widgets.md    | 5 +++++
 5 files changed, 19 insertions(+)
 create mode 100644 docs/categories/globals.md
 create mode 100644 docs/categories/others.md
 create mode 100644 docs/categories/screens.md
 create mode 100644 docs/categories/widgets.md

diff --git a/.github/workflows/dartdoc.yml b/.github/workflows/dartdoc.yml
index c80148d..1314454 100644
--- a/.github/workflows/dartdoc.yml
+++ b/.github/workflows/dartdoc.yml
@@ -22,6 +22,7 @@ jobs:
         run: |
           sudo snap install flutter --classic
           flutter
+          flutter pub get
       # change to 
       - name: run documentation generator
         working-directory: ./revoiceme
diff --git a/docs/categories/globals.md b/docs/categories/globals.md
new file mode 100644
index 0000000..2ef667f
--- /dev/null
+++ b/docs/categories/globals.md
@@ -0,0 +1,4 @@
+# Globals
+
+**Globals** are non-screen (screen as in the category Screens) pieces of code that rely on a custom, specific global state of the ReVoiceMe app.
+They will not function properly otherwise.
diff --git a/docs/categories/others.md b/docs/categories/others.md
new file mode 100644
index 0000000..6135ec3
--- /dev/null
+++ b/docs/categories/others.md
@@ -0,0 +1,3 @@
+# Others
+
+**Others** contains special code parts of the project that do not fit into any other category.
diff --git a/docs/categories/screens.md b/docs/categories/screens.md
new file mode 100644
index 0000000..7e34056
--- /dev/null
+++ b/docs/categories/screens.md
@@ -0,0 +1,6 @@
+# Screens
+
+**Screens** are the biggest building blocks of the app.
+They are composed of multiple components.
+They define the overall layout, navigation, structure and flow of the app.
+Appearance and features between screens is very distinct.
diff --git a/docs/categories/widgets.md b/docs/categories/widgets.md
new file mode 100644
index 0000000..3fff6bf
--- /dev/null
+++ b/docs/categories/widgets.md
@@ -0,0 +1,5 @@
+# Widgets
+
+**Widgets** are typically small and reusable components.
+They are the basic building blocks of the app.
+Multiple widgets can be combined into bigger components or screens.