fx documentation to new ux

Barklarm · Aug 22, 2024 · 68000c9 · 68000c9
1 parent 3bd0231
commit 68000c9
Show file tree

Hide file tree

Showing 19 changed files with 42 additions and 20 deletions.
diff --git a/docs/application/configuration-window.md b/docs/application/configuration-window.md
@@ -6,12 +6,12 @@ sidebar_position: 2
 
 This is the place to set up application configurations that can be found in the [configuration section](/docs/configuration).
 
-![Configuration window](./img/configuration_window.jpeg)
+![Configuration window](./img/configuration_window_observers.png)
 
 The sections it contains are:
 
 * Projects: you can add/remove/modify observing capacities of your different running projects.
 
 It can be accessed from the Tray menu through the configuration button
 
-![menu](./img/menu.jpeg)
+![menu](./img/menu.png)
diff --git a/docs/application/img/configuration_window.jpeg b/docs/application/img/configuration_window.jpeg
diff --git a/docs/application/img/configuration_window_observers.png b/docs/application/img/configuration_window_observers.png
diff --git a/docs/application/img/configuration_window_settings.png b/docs/application/img/configuration_window_settings.png
diff --git a/docs/application/img/fail_icon.png b/docs/application/img/fail_icon.png
diff --git a/docs/application/img/fail_icon_big.png b/docs/application/img/fail_icon_big.png
diff --git a/docs/application/img/menu.jpeg b/docs/application/img/menu.jpeg
diff --git a/docs/application/img/menu.png b/docs/application/img/menu.png
diff --git a/docs/application/img/na_icon.png b/docs/application/img/na_icon.png
diff --git a/docs/application/img/na_icon_big.png b/docs/application/img/na_icon_big.png
diff --git a/docs/application/img/ok_icon.png b/docs/application/img/ok_icon.png
diff --git a/docs/application/img/ok_icon_big.png b/docs/application/img/ok_icon_big.png
diff --git a/docs/application/img/running_icon.png b/docs/application/img/running_icon.png
diff --git a/docs/application/img/running_icon_big.png b/docs/application/img/running_icon_big.png
diff --git a/docs/application/img/summary_icon.jpeg b/docs/application/img/summary_icon.jpeg
diff --git a/docs/application/img/summary_icon.png b/docs/application/img/summary_icon.png
diff --git a/docs/application/menu.md b/docs/application/menu.md
@@ -8,13 +8,13 @@ sidebar_position: 1
 
 The summary icon in the tray bar represents the global state of all the configured builds. The meaning of the icon can be found in the [legend section](#legend) of this page.
 
-![Summary Icon](./img/summary_icon.jpeg)
+![Summary Icon](./img/summary_icon.png)
 
 ## Menu
 
 The Summary icon can be right-clicked, this will display the next menu:
 
-![menu](./img/menu.jpeg)
+![menu](./img/menu.png)
 
 This menu is constituted of the next sections:
 

diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/quick-start.mdx b/docs/quick-start.mdx
@@ -0,0 +1,38 @@
+---
+sidebar_position: 2
+---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Quick Start
+
+Let's discover **Barklarm in less than 120 seconds**.
+
+<video controls src='/video/intro.webm' width="700" height="400" />
+
+## Getting Started
+
+
+### Install
+
+#### Using Package Manager
+
+<Tabs>
+  <TabItem value="osx" label="OSX" default>
+    ```bash
+        # Using brew
+        brew install --cask barklarm/barklarm/barklarm
+    ```
+  </TabItem>
+  <TabItem value="windows" label="Windows">
+    ```bash
+        # Using chocolatey
+        choco install barklarm
+    ```
+  </TabItem>
+</Tabs>
+
+#### Manual
+Get started by:
+- [downloading barklarm](https://github.com/kanekotic/barklarm/releases)
+- Execute installer