Merge pull request #555 from GetStream/doc-fix

Doc fix
2021-07-16 17:54:43 +02:00
parent a292492094 2d5d0f125c
commit cb460ac581
6 changed files with 9 additions and 10 deletions
@@ -44,6 +44,8 @@ this package and accessible via providers and builders.

 Before going into the docs, let's take a small detour to look at how the elements of Stream Chat are structured.

+### Basic Structure
+
 There are two core elements in chat, <b>Users and Channels.</b>
 Channels are groups of one or more users that can message each other.
 In an app, you need to have a user connected to query channels.
@@ -55,7 +57,9 @@ but there is a way to create a unique chat between a certain number of people by

 In essence, a normal two-person chat would be a <b>distinct channel</b> created with two members (you cannot add or delete members in this channel), whereas a group created with two people would simply be a <b>non distinct channel</b> (possible to add or remove members).

-Note: It is also possible to add more than two people in a distinct channel which retains the same add/removal properties and resembles the Slack DMs where you can DM one or more people as well.
+:::note
+It is also possible to add more than two people in a distinct channel which retains the same add/removal properties and resembles the Slack DMs where you can DM one or more people as well.
+:::

 In summary, if you were creating a Whatsapp-like app, the first screen would be a <b>list of channels</b> - which on opening would show a <b>list of messages</b> that were sent by the users in the Channel.

@@ -1,6 +1,6 @@
 ---
 id: adding_custom_attachments
-sidebar_position: 4
+sidebar_position: 3
 title: Adding Custom Attachments
 ---

@@ -1,6 +1,6 @@
 ---
 id: local_data_persistence
-sidebar_position: 2
+sidebar_position: 1
 title: Adding Local Data Persistence
 ---

@@ -1,6 +1,6 @@
 ---
 id: adding_push_notifications
-sidebar_position: 3
+sidebar_position: 2
 title: Adding Push Notifications
 ---

@@ -1,5 +0,0 @@
---
-id: introduction
-sidebar_position: 1
-title: Introduction
---
@@ -1,6 +1,6 @@
 ---
 id: mig_guide_2_0
-sidebar_position: 5
+sidebar_position: 4
 title: Migrating to 2.0 (Null-safety)
 ---