ci(dartdoc): install dependencies in workflow

IKE-B · Oct 19, 2024 · 8977ece · 8977ece
1 parent b71f588
commit 8977ece
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Others

		Others contains special code parts of the project that do not fit into any other category.