docs-seo

.cursorignore

@@ -0,0 +1,9 @@
+# Add directories or file patterns to ignore during indexing (e.g. foo/ or *.csv)
+**/.kotlin/
+**/.gradle/
+**/.idea/
+**/build
+.idea
+.kotlin
+.build
+.gradle

.github/workflows/docs.yml

@@ -55,7 +55,9 @@ jobs:
           cache-dependency-path: './docs/package-lock.json'
 
       - name: Update docs/README.md
-        run: cp ./README.md ./docs/docs/README.md
+        run: |
+          chmod -R +x ./scripts
+          ./scripts/update_readme.sh
 
       - name: Install docs deps
         run: cd docs && npm ci

.gitignore

@@ -162,6 +162,7 @@ hs_err_pid*
 /.idea/other.xml
 
 ### Custom rules
+.kotlin
 .firebase-service-account.json
 /.idea/artifacts/**
 !gradle/gradle-wrapper.jar

README.md

@@ -1,4 +1,4 @@
-![](https://opensource.respawn.pro/FlowMVI/banner.png)
+![FlowMVI Framework Banner](https://opensource.respawn.pro/FlowMVI/banner.webp)
 
 [![CI](https://github.com/respawn-app/FlowMVI/actions/workflows/ci.yml/badge.svg)](https://github.com/respawn-app/FlowMVI/actions/workflows/ci.yml)
 ![License](https://img.shields.io/github/license/respawn-app/flowMVI)
@@ -384,7 +384,13 @@ timerPlugin(timer).test(Loading) {
 IDE plugin generates code and lets you debug and control your app remotely:
 [![Plugin](https://img.shields.io/jetbrains/plugin/v/25766?style=flat)](https://plugins.jetbrains.com/plugin/25766-flowmvi)
 
-https://github.com/user-attachments/assets/05f8efdb-d125-4c4a-9bda-79875f22578f
+<video 
+  src='https://github.com/user-attachments/assets/05f8efdb-d125-4c4a-9bda-79875f22578f'
+  controls
+  width="100%"
+  alt="FlowMVI IDE Plugin Demo">
+  Your browser does not support the video element. You can view the demo at our website.
+</video>
 
 ## People love the library:
 

docs/docs/README.md

@@ -1,3 +1,13 @@
+---
+title: FlowMVI
+title_meta: FlowMVI - Kotlin Architecture Framework
+sidebar_label: Home
+sidebar_position: 0
+hide_title: true
+description: Architecture Framework for Kotlin. Reuse every line of code. Handle all errors automatically. No boilerplate. Analytics, metrics, debugging in 3 lines. 50+ features.
+slug: /
+---
+
 # FlowMVI
 
 ### Stub readme file, do not edit!