feat: add docs for realtime stores (#26983)

* feat: add docs for realtime stores

* fix: remove local store docs

* fix: ci checks [skip style guide checks]

* fix: slugs

* fix: add redirects for changed slugs

* fix: ci checks [skip style guide checks]

* PCX review

* Apply suggestions from code review

* Update src/content/docs/realtime/realtimekit/collaborative-stores/index.mdx

Co-authored-by: Swapnil Madavi <[email protected]>

* Update src/content/docs/realtime/realtimekit/collaborative-stores/index.mdx

Co-authored-by: Swapnil Madavi <[email protected]>

* Update src/content/docs/realtime/realtimekit/collaborative-stores/index.mdx

Co-authored-by: Swapnil Madavi <[email protected]>

* Update src/content/docs/realtime/realtimekit/collaborative-stores/index.mdx

Co-authored-by: Swapnil Madavi <[email protected]>

* Apply suggestion from @swapnilmadavi

Co-authored-by: Swapnil Madavi <[email protected]>

* Apply suggestion from @swapnilmadavi

Co-authored-by: Swapnil Madavi <[email protected]>

* fix: store api methods [skip style guide checks]

* fix: remove api for populating stores [skip style guide checks]

* fix: remove duplicate note [skip style guide checks]

---------

Co-authored-by: Jun Lee <[email protected]>
Co-authored-by: Swapnil Madavi <[email protected]>

Author: 3 people

public/__redirects

@@ -338,6 +338,7 @@
 /realtime/pricing/ /realtime/sfu/pricing/ 302
 /realtime/changelog/ /realtime/sfu/changelog/ 302
 /realtime/realtimekit/get-started/ /realtime/realtimekit/quickstart/ 302
+/realtime/realtimekit/core/breakout-rooms/ /realtime/realtimekit/ui-kit/breakout-rooms/ 302
 /realtime/realtimekit/getting-started/ /realtime/realtimekit/quickstart/ 302
 /realtime/introduction/ /realtime/realtimekit/introduction/ 302
 /realtime/concepts/ /realtime/realtimekit/concepts/ 302

src/content/docs/realtime/realtimekit/collaborative-stores/index.mdx

@@ -0,0 +1,91 @@
+---
+pcx_content_type: navigation
+title: Storage and Broadcast
+sidebar:
+  label: Collaborative Stores
+  order: 7
+---
+
+The RealtimeKit Stores API allows you to create multiple key-value pair realtime stores. Users can subscribe to changes in a store and receive real-time updates. Data is stored until a [session](/realtime/realtimekit/concepts/meeting/#session) is active.
+
+### Create a Store
+
+You can create a realtime store (changes are synced with other users):
+
+| Param     | Type | Description | Required |
+| --------- | --- | --- | --- |
+| `name` | string | Name of the store | true |
+
+To create a store:
+
+```ts
+const store = meeting.stores.create('myStore');
+```
+
+:::note
+This method must be executed for every user.
+:::
+
+### Update a Store
+
+You can add, update or delete entires in a store:
+
+| Param | Type       | Description                                                 | Required |
+| ----- | ---------- | ----------------------------------------------------------- | -------- |
+| `key`   | string     | Unique identifier used to store/update a value in the store | Yes      |
+| `value` | StoreValue | Value that can be stored agains a key                       | Yes      |
+
+
+```ts
+type StoreValue = string | number | object | array;
+```
+```ts
+const { stores } = meeting.stores;
+const store = stores.get('myStore');
+
+await store.set('user', { name: 'John Doe' });
+
+await store.update('user', { age: 34 });  // { name: 'John Doe', age: 34 }
+
+await store.delete('user');
+```
+
+:::note
+The `set` method overwrites the existing value, while the `update` method updates the existing value.
+    
+For example, if the stored value is `['a', 'b']` and you call `update` with `['c']`, the final value will be `['a', 'b', 'c']`.
+:::
+
+
+### Subscribe to a Store
+
+You can attach event listeners on a store's key, which fire when the value changes.
+
+```ts
+const { stores } = meeting.stores;
+const store = stores.get('myStore');
+store.subscribe('key', (data) => { 
+    console.log(data);
+});
+
+// subscribe to all keys of a store
+store.subscribe('*', (data) => { 
+    console.log(data);
+});
+
+store.unsubscribe('key');
+```
+
+### Fetch Store Data
+
+You can fetch the data stored in the store:
+```ts
+const { stores } = meeting.stores;
+const store = stores.get('myStore');
+
+// fetch value for a specific key
+const data = store.get('key');
+
+// fetch all the data in the store
+const data = store.getAll();
+```

src/content/docs/realtime/realtimekit/faq.mdx

@@ -3,7 +3,7 @@ pcx_content_type: navigation
 title: FAQ
 slug: realtime/realtimekit/faq
 sidebar:
-  order: 8
+  order: 9
 ---
 import { Details } from "~/components";
 

src/content/docs/realtime/realtimekit/legal/index.mdx

@@ -3,7 +3,7 @@ pcx_content_type: navigation
 title: Legal
 hideChildren: true
 sidebar:
-  order: 9
+  order: 10
 
 ---
 

src/content/docs/realtime/realtimekit/quickstart.mdx

@@ -36,20 +36,18 @@ Select a framework based on the platform you are building for.
 <RTKSDKSelector />
 
 <RTKCodeSnippet id="web-react">
-
-Please install the following dependencies into your project repository:
-
-```bash
-npm i @cloudflare/realtimekit-react @cloudflare/realtimekit-react-ui
-```
-
-_Optional:_ You can also build on top of our ready-made template:
-
-```bash
-git clone https://github.com/cloudflare/realtimekit-web-examples.git
-cd realtimekit-web-examples/react-examples/examples/default-meeting-ui
-```
-
+	Please install the following dependancies into your project repository:
+  
+	```bash 
+  npm i @cloudflare/realtimekit-react @cloudflare/realtimekit-react-ui
+	``` 
+  
+  _Optional:_ You can also build on top of our ready-made template: 
+  
+  ```bash
+	git clone https://github.com/cloudflare/realtimekit-web-examples.git cd
+	realtimekit-web-examples/react-examples/examples/default-meeting-ui 
+  ```
 </RTKCodeSnippet>
 
 <RTKCodeSnippet id="web-web-components">

src/content/docs/realtime/realtimekit/recording-guide/index.mdx

@@ -2,7 +2,7 @@
 pcx_content_type: navigation
 title: Recording
 sidebar:
-  order: 7
+  order: 8
   label: Overview
 ---
 

src/content/docs/realtime/realtimekit/rest-api-reference.mdx

@@ -4,7 +4,7 @@ title: REST API Reference
 slug: realtime/realtimekit/rest-api-reference
 external_link: /api/resources/realtime_kit/
 sidebar:
-  order: 8
+  order: 11
   badge:
     text: API
     variant: note

src/content/docs/realtime/realtimekit/ui-kit/breakout-rooms.mdx

@@ -1,7 +1,6 @@
 ---
 pcx_content_type: navigation
 title: Breakout Rooms
-slug: realtime/realtimekit/core/breakout-rooms
 sidebar:
   order: 8
 ---