add stream frame reference

botisimo · May 16, 2022 · 7460cd5 · 7460cd5
1 parent b3b605d
commit 7460cd5
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 5 deletions.
diff --git a/docs/frame/index.rst b/docs/frame/index.rst
@@ -0,0 +1,32 @@
+Stream Frame
+============
+
+Your Stream Frame is a ready-made template with automatic stream labels, alerts, and live chat overlay.
+
+You can manage your Stream Frame from `this page <https://botisimo.com/account/frame>`_.
+
+**Set Up Your Stream Frame**
+
+* Log in to your Botisimo account and go to the `Stream Frame manager <https://botisimo.com/account/frame>`_.
+
+.. image:: /images/stream-frame-1.gif
+
+* Find a theme you love and equip it to your frame.
+
+.. image:: /images/stream-frame-2.gif
+
+* Select which stream labels you want to display in your frame.
+
+.. image:: /images/stream-frame-3.gif
+
+* Copy your frame URL and load it into OBS.
+
+.. image:: /images/stream-frame-4.gif
+
+* Add your webcam and content window behind the frame.
+
+.. image:: /images/stream-frame-5.gif
+
+* Start streaming with your new look!
+
+.. image:: /images/stream-frame-6.gif
diff --git a/docs/images/stream-frame-1.gif b/docs/images/stream-frame-1.gif
diff --git a/docs/images/stream-frame-2.gif b/docs/images/stream-frame-2.gif
diff --git a/docs/images/stream-frame-3.gif b/docs/images/stream-frame-3.gif
diff --git a/docs/images/stream-frame-4.gif b/docs/images/stream-frame-4.gif
diff --git a/docs/images/stream-frame-5.gif b/docs/images/stream-frame-5.gif
diff --git a/docs/images/stream-frame-6.gif b/docs/images/stream-frame-6.gif
diff --git a/docs/index.rst b/docs/index.rst
@@ -138,6 +138,20 @@ Stream overlays are browser based sources that you can add into your streaming s
 
    overlays/index
 
+Stream Frame
+^^^^^^^^^^^^
+
+Your Stream Frame is a ready-made template with automatic stream labels, alerts, and live chat overlay.
+
+:doc:`Learn About Stream Frame → <frame/index>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: sec-frame
+   :hidden:
+
+   frame/index
+
 Response Variables
 ^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/loyalty/documentation/authentication.rst b/docs/loyalty/documentation/authentication.rst
@@ -98,7 +98,7 @@ password    string
 Response
 
 ================================= ======== ==========================================================================
-Field                       Type     Description
+Field                             Type     Description
 ================================= ======== ==========================================================================
 token                             string   Token for future requests that require authentication
 user                              object   Information about the logged in user

diff --git a/docs/loyalty/documentation/missions.rst b/docs/loyalty/documentation/missions.rst
@@ -12,6 +12,8 @@ List available missions
 
 - **GET** /mission/list
 
+Mission type can be: ``follow``, ``profile``, ``code``, ``qr-code``
+
 Request
 
 =========== ======== ==========================================
@@ -92,11 +94,11 @@ Complete mission
 
 Request
 
-=========== ======== ==========================================
+=========== ======== =============================================
 Field       Type     Description
-=========== ======== ==========================================
-\-          \-       \-
-=========== ======== ==========================================
+=========== ======== =============================================
+code        [string] Required if ``code`` mission
+=========== ======== =============================================
 
 .. code-block:: js