Sample docs

.gitattributes

@@ -0,0 +1,6 @@
+docs/tutorial/broadcaster/sign_in.png filter=lfs diff=lfs merge=lfs -text
+docs/tutorial/broadcaster/add_admin.png filter=lfs diff=lfs merge=lfs -text
+docs/tutorial/broadcaster/canvas_resolution.png filter=lfs diff=lfs merge=lfs -text
+docs/tutorial/broadcaster/client_empty.png filter=lfs diff=lfs merge=lfs -text
+docs/tutorial/broadcaster/client_startup.png filter=lfs diff=lfs merge=lfs -text
+docs/tutorial/broadcaster/download_client.png filter=lfs diff=lfs merge=lfs -text

docs/index.md

@@ -1 +1,7 @@
 # Imgfloat
+
+Imgfloat is a real-time interactive OBS stream overlay. It allows channel administrators to display [images](./console/assets/images.md) and [videos](./console/assets/videos.md), play [audio](./console/assets/audio.md) and [anything else that you can code](./console/assets/scripts/overview.md) on the broadcast. Updates happen in real time so you can immediately see the changes on stream.
+
+Want to get started? Checkout out the simple guide [as a broadcaster](./tutorial/broadcaster/overview.md) or [as a channel administrator](./tutorial/channel_admin/overview.md) or check out [https://imgflo.at](https://imgflo.at) to jump in right away.
+
+Imgfloat is a free and open source project and you are free to host it yourself if you prefer. You can find the source code on [GitHub](https://github.com/imgfloat).

docs/tutorial/broadcaster/obs.md

@@ -0,0 +1,5 @@
+# Configuring OBS
+
+To add the Imgfloat client window to OBS, start by opening OBS and adding a new source. Select "Window Capture" as the source type.
+
+

docs/tutorial/broadcaster/overview.md

@@ -0,0 +1,27 @@
+# Getting started as a broadcaster
+
+Sign in with your Twitch account on [imgflo.at](https://imgflo.at) (or on your own instance) to register with the application.
+
+![Sign in with Twitch](./sign_in.png)
+
+Once signed in, you can add a channel administrator by entering their Twitch username. There is also a list of recommended channel administrators that you can add with a single click pulled from your Twitch moderator list.
+
+If you just want to test things out, you can skip this step for now, as you have access to your own channel admin dashboard (if you decide to go this route it is recommended that you check out [Getting started as a channel admin](../channel_admin/overview.md)).
+
+![Add admin](./add_admin.png)
+
+Finally, make sure to configure the canvas resolution to match your OBS settings. This ensures that the canvas covers the entire stream.
+
+![Canvas resolution](./canvas_resolution.png)
+
+Now you're ready to download the client. The download link can be found on the index page or on your dashboard. Make sure you pick the right version for your operating system (currently Windows 10/11, MacOS (ARM) and GNU/Linux via appimage).
+
+![Download client](./download_client.png)
+
+Once installed, simply enter your Twitch username in the client (optionally change the domain if using a self-hosted solution) and connect. This will create a transparent window with a title bar (assuming you didn't yet add any assets).
+
+![Client startup](./client_startup.png)
+
+![Client empty](./client_empty.png)
+
+Now we're ready to add the window to OBS.

mkdocs.yml

@@ -13,11 +13,11 @@ nav:
   - Home: index.md
   - Getting Started:
     - Broadcaster: 
-      - Overview: tutorial/broadcaster/overview.md
+      - Getting Started: tutorial/broadcaster/overview.md
       - OBS setup: tutorial/broadcaster/obs.md
       - Integrations: tutorial/broadcaster/integrations.md
     - Channel Admin: 
-      - Overview: tutorial/channel_admin/overview.md
+      - Getting Started: tutorial/channel_admin/overview.md
       - Register: tutorial/channel_admin/register.md
   - Admin Console:
     - Overview: console/overview.md

uv.lock

@@ -25,7 +25,7 @@ wheels = [
 
 [[package]]
 name = "docs"
-version = "0.1.0"
+version = "1.0.0"
 source = { virtual = "." }
 dependencies = [
     { name = "markdown-include" },