From d0e06d96d87b47a32202a5f115c1f529222fb80e Mon Sep 17 00:00:00 2001 From: Sacha Arbonel Date: Mon, 31 Oct 2022 10:05:30 -0400 Subject: [PATCH] Docs: reorganize sidebar docs + fix broken links (#1369) * reorganize sidebar docs * fix broken links * tweaks --- .../docs/Flutter/01-basics/_category_.json | 3 +++ .../{basics => 01-basics}/choose_package.mdx | 4 +++- .../{basics => 01-basics}/introduction.mdx | 4 ++-- .../versioning_policy.mdx | 0 .../01-customize_message_widget.mdx} | 15 ++++++------ .../02-customize_text_messages.mdx} | 5 ++-- .../03-customize_message_actions.mdx} | 5 ++-- .../04-adding_custom_attachments.mdx} | 9 ++++--- .../05-customize_attachment_picker_modal.mdx} | 4 ++-- .../06-autocomplete_triggers.mdx} | 4 ++-- .../07-slidable_channel_list_preview.mdx} | 7 +++--- .../01-custom-widgets/_category_.json | 3 +++ .../Flutter/02-customization/_category_.json | 3 +++ .../stream_chat_and_theming.mdx | 4 ++-- .../03-stream_chat_flutter/_category_.json | 3 +++ .../introduction.mdx | 0 .../setup.mdx | 0 .../stream_channel_grid_view.mdx | 0 .../stream_channel_header.mdx | 0 .../stream_channel_list_header.mdx | 0 .../stream_channel_list_view.mdx | 2 +- .../stream_member_grid_view.mdx | 0 .../stream_member_list_view.mdx | 2 +- .../stream_message_input.mdx | 2 +- .../stream_message_list_view.mdx | 0 .../stream_message_search_grid_view.mdx | 0 .../stream_message_search_list_view.mdx | 2 +- .../stream_message_widget.mdx | 0 .../stream_user_grid_view.mdx | 0 .../stream_user_list_view.mdx | 2 +- .../_category_.json | 3 +++ .../introduction.mdx | 0 .../lazy_load_scroll_view.mdx | 0 .../message_list_core.mdx | 0 .../paged_value_listenable_builder.mdx | 0 .../setup.mdx | 0 .../stream_channel_list_controller.mdx | 2 +- .../stream_channel_list_event_handler.mdx | 0 .../stream_chat_core.mdx | 0 .../stream_member_list_controller.mdx | 2 +- .../stream_message_input_controller.mdx | 2 +- .../stream_message_search_list_controller.mdx | 2 +- .../stream_user_list_controller.mdx | 2 +- .../01-understanding_filters.mdx} | 3 +-- .../02-adding_local_data_persistence.mdx} | 5 ++-- ...r_token_generation_with_firebase_auth.mdx} | 3 +-- .../04-adding_localization.mdx} | 5 ++-- .../05-push-notifications/_category_.json | 3 +++ .../adding_push_notifications.mdx | 14 +++++------ .../adding_push_notifications_v2.mdx | 8 +++---- .../06-end_to_end_chat_encryption.mdx} | 5 ++-- .../07-error_reporting_with_sentry.mdx} | 3 +-- .../08-adding_chat_to_video_livestreams.mdx} | 3 +-- .../05-guides/08-migrations/_category_.json | 3 +++ .../08-migrations}/migration_guide_4_0.mdx | 24 +++++++++---------- .../08-migrations}/migration_guide_5_0.mdx | 16 ++++++------- .../docs/Flutter/05-guides/_category_.json | 3 +++ .../docs/Flutter/basics/_category_.json | 4 ---- .../docs/Flutter/guides/_category_.json | 4 ---- .../stream_chat_flutter/_category_.json | 4 ---- .../stream_chat_flutter_core/_category_.json | 4 ---- .../Flutter/guides/autocomplete_triggers.mdx | 2 +- .../stream_channel_list_view.mdx | 2 +- .../stream_message_input.mdx | 2 +- .../stream_message_search_list_view.mdx | 2 +- .../stream_user_list_view.mdx | 2 +- 66 files changed, 110 insertions(+), 110 deletions(-) create mode 100644 docusaurus/docs/Flutter/01-basics/_category_.json rename docusaurus/docs/Flutter/{basics => 01-basics}/choose_package.mdx (97%) rename docusaurus/docs/Flutter/{basics => 01-basics}/introduction.mdx (98%) rename docusaurus/docs/Flutter/{basics => 01-basics}/versioning_policy.mdx (100%) rename docusaurus/docs/Flutter/{guides/customize_message_widget.mdx => 02-customization/01-custom-widgets/01-customize_message_widget.mdx} (94%) rename docusaurus/docs/Flutter/{guides/customize_text_messages.mdx => 02-customization/01-custom-widgets/02-customize_text_messages.mdx} (98%) rename docusaurus/docs/Flutter/{guides/customize_message_actions.mdx => 02-customization/01-custom-widgets/03-customize_message_actions.mdx} (95%) rename docusaurus/docs/Flutter/{guides/adding_custom_attachments.mdx => 02-customization/01-custom-widgets/04-adding_custom_attachments.mdx} (97%) rename docusaurus/docs/Flutter/{guides/customize_attachment_picker_modal.mdx => 02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx} (97%) rename docusaurus/docs/Flutter/{guides/autocomplete_triggers.mdx => 02-customization/01-custom-widgets/06-autocomplete_triggers.mdx} (93%) rename docusaurus/docs/Flutter/{guides/slidable_channel_list_preview.mdx => 02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx} (96%) create mode 100644 docusaurus/docs/Flutter/02-customization/01-custom-widgets/_category_.json create mode 100644 docusaurus/docs/Flutter/02-customization/_category_.json rename docusaurus/docs/Flutter/{stream_chat_flutter => 02-customization}/stream_chat_and_theming.mdx (98%) create mode 100644 docusaurus/docs/Flutter/03-stream_chat_flutter/_category_.json rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/introduction.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/setup.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_channel_grid_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_channel_header.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_channel_list_header.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_channel_list_view.mdx (93%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_member_grid_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_member_list_view.mdx (90%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_message_input.mdx (93%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_message_list_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_message_search_grid_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_message_search_list_view.mdx (88%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_message_widget.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_user_grid_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter => 03-stream_chat_flutter}/stream_user_list_view.mdx (90%) create mode 100644 docusaurus/docs/Flutter/04-stream_chat_flutter_core/_category_.json rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/introduction.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/lazy_load_scroll_view.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/message_list_core.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/paged_value_listenable_builder.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/setup.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_channel_list_controller.mdx (97%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_channel_list_event_handler.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_chat_core.mdx (100%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_member_list_controller.mdx (96%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_message_input_controller.mdx (95%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_message_search_list_controller.mdx (97%) rename docusaurus/docs/Flutter/{stream_chat_flutter_core => 04-stream_chat_flutter_core}/stream_user_list_controller.mdx (97%) rename docusaurus/docs/Flutter/{guides/understanding_filters.mdx => 05-guides/01-understanding_filters.mdx} (98%) rename docusaurus/docs/Flutter/{guides/adding_local_data_persistence.mdx => 05-guides/02-adding_local_data_persistence.mdx} (96%) rename docusaurus/docs/Flutter/{guides/user_token_generation_with_firebase_auth.mdx => 05-guides/03-user_token_generation_with_firebase_auth.mdx} (99%) rename docusaurus/docs/Flutter/{guides/adding_localization.mdx => 05-guides/04-adding_localization.mdx} (98%) create mode 100644 docusaurus/docs/Flutter/05-guides/05-push-notifications/_category_.json rename docusaurus/docs/Flutter/{guides => 05-guides/05-push-notifications}/adding_push_notifications.mdx (97%) rename docusaurus/docs/Flutter/{guides => 05-guides/05-push-notifications}/adding_push_notifications_v2.mdx (97%) rename docusaurus/docs/Flutter/{guides/end_to_end_chat_encryption.mdx => 05-guides/06-end_to_end_chat_encryption.mdx} (99%) rename docusaurus/docs/Flutter/{guides/error_reporting_with_sentry.mdx => 05-guides/07-error_reporting_with_sentry.mdx} (98%) rename docusaurus/docs/Flutter/{guides/adding_chat_to_video_livestreams.mdx => 05-guides/08-adding_chat_to_video_livestreams.mdx} (97%) create mode 100644 docusaurus/docs/Flutter/05-guides/08-migrations/_category_.json rename docusaurus/docs/Flutter/{guides => 05-guides/08-migrations}/migration_guide_4_0.mdx (96%) rename docusaurus/docs/Flutter/{guides => 05-guides/08-migrations}/migration_guide_5_0.mdx (92%) create mode 100644 docusaurus/docs/Flutter/05-guides/_category_.json delete mode 100644 docusaurus/docs/Flutter/basics/_category_.json delete mode 100644 docusaurus/docs/Flutter/guides/_category_.json delete mode 100644 docusaurus/docs/Flutter/stream_chat_flutter/_category_.json delete mode 100644 docusaurus/docs/Flutter/stream_chat_flutter_core/_category_.json diff --git a/docusaurus/docs/Flutter/01-basics/_category_.json b/docusaurus/docs/Flutter/01-basics/_category_.json new file mode 100644 index 00000000..69a9460d --- /dev/null +++ b/docusaurus/docs/Flutter/01-basics/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Basics" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/basics/choose_package.mdx b/docusaurus/docs/Flutter/01-basics/choose_package.mdx similarity index 97% rename from docusaurus/docs/Flutter/basics/choose_package.mdx rename to docusaurus/docs/Flutter/01-basics/choose_package.mdx index 8be73f01..cd311b63 100644 --- a/docusaurus/docs/Flutter/basics/choose_package.mdx +++ b/docusaurus/docs/Flutter/01-basics/choose_package.mdx @@ -1,9 +1,11 @@ --- id: choose_package sidebar_position: 2 -title: Choosing The Right Flutter Package +title: Choosing The Right SDK --- +Choosing The Right Flutter Package + ### Why the SDK is split into different packages Different applications need different levels of customization and integration with the Stream Chat SDK. diff --git a/docusaurus/docs/Flutter/basics/introduction.mdx b/docusaurus/docs/Flutter/01-basics/introduction.mdx similarity index 98% rename from docusaurus/docs/Flutter/basics/introduction.mdx rename to docusaurus/docs/Flutter/01-basics/introduction.mdx index 99170774..93f0572d 100644 --- a/docusaurus/docs/Flutter/basics/introduction.mdx +++ b/docusaurus/docs/Flutter/01-basics/introduction.mdx @@ -2,9 +2,9 @@ slug: / id: introduction sidebar_position: 1 -title: About The Flutter SDK +title: Overview --- -Exploring The Basics Of Stream Chat +About The Flutter SDK ![](../assets/sdk_title.png) diff --git a/docusaurus/docs/Flutter/basics/versioning_policy.mdx b/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx similarity index 100% rename from docusaurus/docs/Flutter/basics/versioning_policy.mdx rename to docusaurus/docs/Flutter/01-basics/versioning_policy.mdx diff --git a/docusaurus/docs/Flutter/guides/customize_message_widget.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/01-customize_message_widget.mdx similarity index 94% rename from docusaurus/docs/Flutter/guides/customize_message_widget.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/01-customize_message_widget.mdx index c4878188..93611740 100644 --- a/docusaurus/docs/Flutter/guides/customize_message_widget.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/01-customize_message_widget.mdx @@ -1,10 +1,9 @@ --- id: customize_message_widget -sidebar_position: 11 -title: Customizing The StreamMessageWidget +title: Message --- -Customizing Text Messages +Customizing Text Messages with the StreamMessageWidget ### Introduction @@ -63,7 +62,7 @@ StreamChatThemeData( ) ``` -![](../assets/message_theming.png) +![](../../assets/message_theming.png) #### Change message text style @@ -79,7 +78,7 @@ StreamMessageThemeData( ) ``` -![](../assets/message_styles.png) +![](../../assets/message_styles.png) #### Change avatar theme @@ -93,7 +92,7 @@ StreamMessageThemeData( ) ``` -![](../assets/message_rounded_avatar.png) +![](../../assets/message_rounded_avatar.png) #### Changing Reaction theme @@ -107,7 +106,7 @@ StreamMessageThemeData( ), ``` -![](../assets/message_reaction_theming.png) +![](../../assets/message_reaction_theming.png) ### Changing Message Actions @@ -133,7 +132,7 @@ StreamMessageWidget( ), ``` -![](../assets/message_widget_actions.png) +![](../../assets/message_widget_actions.png) ### Building attachments diff --git a/docusaurus/docs/Flutter/guides/customize_text_messages.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/02-customize_text_messages.mdx similarity index 98% rename from docusaurus/docs/Flutter/guides/customize_text_messages.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/02-customize_text_messages.mdx index 57b3301d..429fc5e2 100644 --- a/docusaurus/docs/Flutter/guides/customize_text_messages.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/02-customize_text_messages.mdx @@ -1,7 +1,6 @@ --- id: customize_text_messages -sidebar_position: 6 -title: Customize Text Messages +title: Message List View --- Customizing Text Messages @@ -155,4 +154,4 @@ We can replace the hashtags using RegEx and add links for the MarkdownBody which `_replaceHashtags()` function. Inside the textBuilder, we use the `flutter_markdown` package to build our hashtags as links. -![](../assets/hashtag_example.jpg) +![](../../assets/hashtag_example.jpg) diff --git a/docusaurus/docs/Flutter/guides/customize_message_actions.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/03-customize_message_actions.mdx similarity index 95% rename from docusaurus/docs/Flutter/guides/customize_message_actions.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/03-customize_message_actions.mdx index 12cc7715..31e2b9d5 100644 --- a/docusaurus/docs/Flutter/guides/customize_message_actions.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/03-customize_message_actions.mdx @@ -1,7 +1,6 @@ --- id: customize_message_actions -sidebar_position: 8 -title: Customize Message Actions +title: Message Actions --- Customizing Message Actions @@ -10,7 +9,7 @@ Customizing Message Actions Message actions pop up in message overlay, when you long-press a message. -![](../assets/message_actions.jpg) +![](../../assets/message_actions.jpg) We have provided granular control over these actions. diff --git a/docusaurus/docs/Flutter/guides/adding_custom_attachments.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/04-adding_custom_attachments.mdx similarity index 97% rename from docusaurus/docs/Flutter/guides/adding_custom_attachments.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/04-adding_custom_attachments.mdx index 559464f7..089dd3e6 100644 --- a/docusaurus/docs/Flutter/guides/adding_custom_attachments.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/04-adding_custom_attachments.mdx @@ -1,7 +1,6 @@ --- id: adding_custom_attachments -sidebar_position: 3 -title: Adding Custom Attachments +title: Attachments --- Adding Your Own Types Of Attachments To A Message @@ -25,7 +24,7 @@ To do this, let's check out an example to add location sharing to Stream Chat. Let's build an example of location sharing option in the app: -![](../assets/location_sharing_example.jpg) +![](../../assets/location_sharing_example.jpg) * Show a "Share Location" button next to StreamMessageInput Textfield. @@ -174,7 +173,7 @@ StreamMessageListView( This gives us the final location attachment: -![](../assets/location_sharing_example_message.jpg) +![](../../assets/location_sharing_example_message.jpg) Additionally, you can also add a thumbnail if a message has a location attachment (unlike in this case, where we sent the message directly). @@ -264,4 +263,4 @@ StreamMessageInput( And we can see the thumbnails in the StreamMessageInput: -![](../assets/location_sharing_example_message_thumbnail.jpg) +![](../../assets/location_sharing_example_message_thumbnail.jpg) diff --git a/docusaurus/docs/Flutter/guides/customize_attachment_picker_modal.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx similarity index 97% rename from docusaurus/docs/Flutter/guides/customize_attachment_picker_modal.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx index 194e785b..77f727c9 100644 --- a/docusaurus/docs/Flutter/guides/customize_attachment_picker_modal.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx @@ -1,6 +1,6 @@ --- id: customize_attachment_picker_modal -title: Customizing the Attachment Picker Modal +title: Attachment Picker Modal --- Customizing the Attachment Picker Modal @@ -8,7 +8,7 @@ Customizing the Attachment Picker Modal ### Introduction The Attachment Picker is a modal that allows users to select attachments from their device. -It is generally used when a user taps the attachment button in the [StreamMessageInput](../stream_chat_flutter/message_input.mdx). +It is generally used when a user taps the attachment button in the [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx). By default, the Attachment Picker provides multiple picker options as per the platform. - For example, on Mobile, the default options are Camera, Gallery, File, and Video. diff --git a/docusaurus/docs/Flutter/guides/autocomplete_triggers.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/06-autocomplete_triggers.mdx similarity index 93% rename from docusaurus/docs/Flutter/guides/autocomplete_triggers.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/06-autocomplete_triggers.mdx index 413d147a..d9a90f39 100644 --- a/docusaurus/docs/Flutter/guides/autocomplete_triggers.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/06-autocomplete_triggers.mdx @@ -1,13 +1,13 @@ --- id: autocomplete_triggers -title: Adding Custom Autocomplete Triggers +title: Autocomplete Triggers --- Adding Custom Autocomplete Triggers ### Introduction -The [StreamMessageInput](../stream_chat_flutter/message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. +The [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones. diff --git a/docusaurus/docs/Flutter/guides/slidable_channel_list_preview.mdx b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx similarity index 96% rename from docusaurus/docs/Flutter/guides/slidable_channel_list_preview.mdx rename to docusaurus/docs/Flutter/02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx index 5a060fd7..67372ef5 100644 --- a/docusaurus/docs/Flutter/guides/slidable_channel_list_preview.mdx +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx @@ -1,7 +1,6 @@ --- id: slidable_channel_list_preview -sidebar_position: 14 -title: Slidable Channel List Preview +title: Channel List Preview --- Slidable Channel List Preview @@ -11,9 +10,9 @@ Slidable Channel List Preview The default slidable behavior within the channel list has been removed in v4 of the Stream Chat Flutter SDK. This guide will show you how you can easily add this functionality yourself. -Please see our [full v4 migration guide](migration_guide_4_0.mdx) if you're migrating from an earlier version of the Stream Chat Flutter SDK. +Please see our [full v4 migration guide](../../05-guides/08-migrations/migration_guide_4_0.mdx) if you're migrating from an earlier version of the Stream Chat Flutter SDK. -![Slidable demo](../assets/slidable_demo.jpg) +![Slidable demo](../../assets/slidable_demo.jpg) ### Prerequisites diff --git a/docusaurus/docs/Flutter/02-customization/01-custom-widgets/_category_.json b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/_category_.json new file mode 100644 index 00000000..7dfd26e6 --- /dev/null +++ b/docusaurus/docs/Flutter/02-customization/01-custom-widgets/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Custom Widgets" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/02-customization/_category_.json b/docusaurus/docs/Flutter/02-customization/_category_.json new file mode 100644 index 00000000..b0b9ad39 --- /dev/null +++ b/docusaurus/docs/Flutter/02-customization/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Customization" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_chat_and_theming.mdx b/docusaurus/docs/Flutter/02-customization/stream_chat_and_theming.mdx similarity index 98% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_chat_and_theming.mdx rename to docusaurus/docs/Flutter/02-customization/stream_chat_and_theming.mdx index d527b738..ff38e1c4 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_chat_and_theming.mdx +++ b/docusaurus/docs/Flutter/02-customization/stream_chat_and_theming.mdx @@ -1,7 +1,7 @@ --- id: stream_chat_and_theming -sidebar_position: 3 -title: StreamChat And Theming +sidebar_position: 1 +title: Theming --- Understanding How To Customize Widgets Using `StreamChatTheme` diff --git a/docusaurus/docs/Flutter/03-stream_chat_flutter/_category_.json b/docusaurus/docs/Flutter/03-stream_chat_flutter/_category_.json new file mode 100644 index 00000000..b323499b --- /dev/null +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "UI Widgets" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/introduction.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/introduction.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/introduction.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/introduction.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/setup.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/setup.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/setup.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/setup.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_grid_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_grid_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_grid_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_grid_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_header.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_header.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_header.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_header.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_list_header.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_list_header.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_list_header.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_list_header.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_list_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_list_view.mdx similarity index 93% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_list_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_list_view.mdx index dbb3f266..e8706290 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_channel_list_view.mdx +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_channel_list_view.mdx @@ -23,7 +23,7 @@ ONLY the channels that the user is a part of. This section goes into setting up widget. :::note -Make sure to check the [StreamChannelListController](./stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. +Make sure to check the [StreamChannelListController](../04-stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. ::: ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_member_grid_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_member_grid_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_member_grid_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_member_grid_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_member_list_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_member_list_view.mdx similarity index 90% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_member_list_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_member_list_view.mdx index 06bfd341..26285876 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_member_list_view.mdx +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_member_list_view.mdx @@ -13,7 +13,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ A list of members is required for many different purposes, for example, showing a list of users in a Channel. The `StreamMemberListView` displays a list of members. :::note -Make sure to check the [StreamMemberListController](./stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`. +Make sure to check the [StreamMemberListController](../04-stream_chat_flutter_core/stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`. ::: ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_input.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_input.mdx similarity index 93% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_message_input.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_input.mdx index b60696ae..8778f3a4 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_input.mdx +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_input.mdx @@ -57,7 +57,7 @@ class ChannelPage extends StatelessWidget { It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget. :::note -Make sure to check the [StreamMessageInputController](./stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. +Make sure to check the [StreamMessageInputController](../04-stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. ::: ### Adding Custom Actions diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_list_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_list_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_message_list_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_list_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_grid_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_search_grid_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_grid_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_search_grid_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_search_list_view.mdx similarity index 88% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_search_list_view.mdx index cf27facf..ca4fd11e 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_search_list_view.mdx @@ -17,7 +17,7 @@ message they are searching for. As such, there needs to be a way to search for a channels. This is where `StreamMessageSearchListView` comes in. :::note -Make sure to check the [StreamMessageSearchListController](./stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. +Make sure to check the [StreamMessageSearchListController](../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. ::: ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_message_widget.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_widget.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_message_widget.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_message_widget.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_grid_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_user_grid_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_user_grid_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_user_grid_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_user_list_view.mdx similarity index 90% rename from docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx rename to docusaurus/docs/Flutter/03-stream_chat_flutter/stream_user_list_view.mdx index 6f424e38..f8fcbf2b 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter/stream_user_list_view.mdx +++ b/docusaurus/docs/Flutter/03-stream_chat_flutter/stream_user_list_view.mdx @@ -17,7 +17,7 @@ selecting users to add in a channel, etc. The `StreamUserListView` displays a li of users. :::note -Make sure to check the [StreamUserListController](../stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. +Make sure to check the [StreamUserListController](../04-stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. ::: ### Basic Example diff --git a/docusaurus/docs/Flutter/04-stream_chat_flutter_core/_category_.json b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/_category_.json new file mode 100644 index 00000000..9737db75 --- /dev/null +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Core Widgets" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/introduction.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/introduction.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/introduction.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/introduction.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/lazy_load_scroll_view.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/lazy_load_scroll_view.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/lazy_load_scroll_view.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/lazy_load_scroll_view.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/message_list_core.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/message_list_core.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/message_list_core.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/message_list_core.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/paged_value_listenable_builder.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/paged_value_listenable_builder.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/paged_value_listenable_builder.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/paged_value_listenable_builder.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/setup.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/setup.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/setup.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/setup.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_channel_list_controller.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_controller.mdx similarity index 97% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_channel_list_controller.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_controller.mdx index c37eeedd..2bf2de33 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_channel_list_controller.mdx +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_controller.mdx @@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ The `StreamChannelListController` is a controller class that allows you to control a list of channels. `StreamChannelListController` is a required parameter of the `StreamChannelListView` widget. -Check the [`StreamChannelListView` documentation](../stream_chat_flutter/stream_channel_list_view.mdx) to read more about that. +Check the [`StreamChannelListView` documentation](../03-stream_chat_flutter/stream_channel_list_view.mdx) to read more about that. The `StreamChannelListController` also listens for various events and manipulates the current list of channels accordingly. Passing a `StreamChannelListEventHandler` to the `StreamChannelListController` will allow you to customize this behaviour. diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_channel_list_event_handler.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_event_handler.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_channel_list_event_handler.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_event_handler.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_chat_core.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_chat_core.mdx similarity index 100% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_chat_core.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_chat_core.mdx diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_member_list_controller.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_member_list_controller.mdx similarity index 96% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_member_list_controller.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_member_list_controller.mdx index c58c6a88..a27d42c8 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_member_list_controller.mdx +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_member_list_controller.mdx @@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ The `StreamMemberListController` is a controller class that allows you to control a list of users. `StreamMemberListController` is a required parameter of the `StreamMemberListView` widget. -Check the [`StreamMemberListView` documentation](../stream_chat_flutter/stream_member_list_view.mdx) to read more about that. +Check the [`StreamMemberListView` documentation](../03-stream_chat_flutter/stream_member_list_view.mdx) to read more about that. ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_input_controller.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_input_controller.mdx similarity index 95% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_input_controller.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_input_controller.mdx index 7139d15e..9520f13c 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_input_controller.mdx +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_input_controller.mdx @@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ The `StreamMessageInputController` is a controller class that embed the business logic to compose a message. `StreamMessageInputController` is a parameter of the `StreamMessageInput` widget. -Check the [`StreamMessageInput` documentation](../stream_chat_flutter/stream_message_input.mdx) to read more about that. +Check the [`StreamMessageInput` documentation](../03-stream_chat_flutter/stream_message_input.mdx) to read more about that. ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_search_list_controller.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_search_list_controller.mdx similarity index 97% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_search_list_controller.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_search_list_controller.mdx index f4546331..dc2608bc 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_message_search_list_controller.mdx +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_message_search_list_controller.mdx @@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ The `StreamMessageSearchListController` is a controller class that allows you to control a list of searched messages. `StreamMessageSearchListController` is a required parameter of the `StreamMessageSearchListView` widget. -Check the [`StreamMessageSearchListView` documentation](../stream_chat_flutter/stream_message_search_list_view.mdx) to read more about that. +Check the [`StreamMessageSearchListView` documentation](../03-stream_chat_flutter/stream_message_search_list_view.mdx) to read more about that. ### Basic Example diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_user_list_controller.mdx b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_user_list_controller.mdx similarity index 97% rename from docusaurus/docs/Flutter/stream_chat_flutter_core/stream_user_list_controller.mdx rename to docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_user_list_controller.mdx index 93a8bcd3..0eba9d35 100644 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/stream_user_list_controller.mdx +++ b/docusaurus/docs/Flutter/04-stream_chat_flutter_core/stream_user_list_controller.mdx @@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_ The `StreamUserListController` is a controller class that allows you to control a list of users. `StreamUserListController` is a required parameter of the `StreamUserListView` widget. -Check the [`StreamUserListView` documentation](../stream_chat_flutter/stream_user_list_view.mdx) to read more about that. +Check the [`StreamUserListView` documentation](../03-stream_chat_flutter/stream_user_list_view.mdx) to read more about that. ### Basic Example diff --git a/docusaurus/docs/Flutter/guides/understanding_filters.mdx b/docusaurus/docs/Flutter/05-guides/01-understanding_filters.mdx similarity index 98% rename from docusaurus/docs/Flutter/guides/understanding_filters.mdx rename to docusaurus/docs/Flutter/05-guides/01-understanding_filters.mdx index 292afd07..88f5ee61 100644 --- a/docusaurus/docs/Flutter/guides/understanding_filters.mdx +++ b/docusaurus/docs/Flutter/05-guides/01-understanding_filters.mdx @@ -1,7 +1,6 @@ --- id: understanding_filters -sidebar_position: 10 -title: Understanding Filters +title: Filters --- Understanding Filters diff --git a/docusaurus/docs/Flutter/guides/adding_local_data_persistence.mdx b/docusaurus/docs/Flutter/05-guides/02-adding_local_data_persistence.mdx similarity index 96% rename from docusaurus/docs/Flutter/guides/adding_local_data_persistence.mdx rename to docusaurus/docs/Flutter/05-guides/02-adding_local_data_persistence.mdx index e6283ca0..dd7ce0c9 100644 --- a/docusaurus/docs/Flutter/guides/adding_local_data_persistence.mdx +++ b/docusaurus/docs/Flutter/05-guides/02-adding_local_data_persistence.mdx @@ -1,10 +1,9 @@ --- id: adding_local_data_persistence -sidebar_position: 9 -title: Adding Local Data Persistence +title: Offline Support --- -Adding Local Data Persistence +Adding Local Data Persistence for Offline Support ### Introduction diff --git a/docusaurus/docs/Flutter/guides/user_token_generation_with_firebase_auth.mdx b/docusaurus/docs/Flutter/05-guides/03-user_token_generation_with_firebase_auth.mdx similarity index 99% rename from docusaurus/docs/Flutter/guides/user_token_generation_with_firebase_auth.mdx rename to docusaurus/docs/Flutter/05-guides/03-user_token_generation_with_firebase_auth.mdx index 631aab4f..b4102b83 100644 --- a/docusaurus/docs/Flutter/guides/user_token_generation_with_firebase_auth.mdx +++ b/docusaurus/docs/Flutter/05-guides/03-user_token_generation_with_firebase_auth.mdx @@ -1,7 +1,6 @@ --- id: token_generation_with_firebase -sidebar_position: 5 -title: User Token Generation With Firebase Auth and Cloud Functions +title: Authentication --- Securely generate Stream Chat user tokens using Firebase Authentication and Cloud Functions. diff --git a/docusaurus/docs/Flutter/guides/adding_localization.mdx b/docusaurus/docs/Flutter/05-guides/04-adding_localization.mdx similarity index 98% rename from docusaurus/docs/Flutter/guides/adding_localization.mdx rename to docusaurus/docs/Flutter/05-guides/04-adding_localization.mdx index b62d887d..c6050d10 100644 --- a/docusaurus/docs/Flutter/guides/adding_localization.mdx +++ b/docusaurus/docs/Flutter/05-guides/04-adding_localization.mdx @@ -1,10 +1,9 @@ --- id: adding_localization -sidebar_position: 2 -title: Adding Localization (l10n) / Internationalization (i18n) +title: Localization --- -Adding Localization To UI Widgets +Adding Localization (l10n) / Internationalization (i18n) To UI Widgets ### Introduction diff --git a/docusaurus/docs/Flutter/05-guides/05-push-notifications/_category_.json b/docusaurus/docs/Flutter/05-guides/05-push-notifications/_category_.json new file mode 100644 index 00000000..26b1d64e --- /dev/null +++ b/docusaurus/docs/Flutter/05-guides/05-push-notifications/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Push Notifications" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx b/docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications.mdx similarity index 97% rename from docusaurus/docs/Flutter/guides/adding_push_notifications.mdx rename to docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications.mdx index 328ba546..1926b93c 100644 --- a/docusaurus/docs/Flutter/guides/adding_push_notifications.mdx +++ b/docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications.mdx @@ -1,7 +1,7 @@ --- id: adding_push_notifications -sidebar_position: 1 -title: Adding Push Notifications (V1 legacy) +sidebar_position: 2 +title: Legacy --- Adding Push Notifications To Your Application @@ -39,7 +39,7 @@ From the [Firebase Console](https://console.firebase.google.com/), select the pr Click on the gear icon next to `Project Overview` and navigate to **Project settings** -![](../assets/firebase_project_settings.jpeg) +![](../../assets/firebase_project_settings.jpeg) #### Step 3 @@ -49,15 +49,15 @@ Navigate to the `Cloud Messaging` tab Under `Project Credentials`, locate the `Server key` and copy it -![](../assets/server_key.png) +![](../../assets/server_key.png) #### Step 5 Upload the `Server Key` in your chat dashboard -![](../assets/dashboard_firebase_enable.jpeg) +![](../../assets/dashboard_firebase_enable.jpeg) -![](../assets/dashboard_firebase_key.jpeg) +![](../../assets/dashboard_firebase_key.jpeg) :::note @@ -68,7 +68,7 @@ We are setting up the Android section, but this will work for both Android and i Save your push notification settings changes -![](../assets/dashboard_save_changes.jpeg) +![](../../assets/dashboard_save_changes.jpeg) **OR** diff --git a/docusaurus/docs/Flutter/guides/adding_push_notifications_v2.mdx b/docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications_v2.mdx similarity index 97% rename from docusaurus/docs/Flutter/guides/adding_push_notifications_v2.mdx rename to docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications_v2.mdx index 917d9216..351e8021 100644 --- a/docusaurus/docs/Flutter/guides/adding_push_notifications_v2.mdx +++ b/docusaurus/docs/Flutter/05-guides/05-push-notifications/adding_push_notifications_v2.mdx @@ -1,10 +1,10 @@ --- id: adding_push_notifications_v2 sidebar_position: 1 -title: Adding Push Notifications (V2) +title: Push Notifications --- -Adding Push Notifications To Your Application +Adding Push Notifications (V2) To Your Application ### Introduction @@ -49,11 +49,11 @@ You can upload your Firebase credentials using either the dashboard or the app s 1. Go to the **Chat Overview** page on Stream Dashboard -![](../assets/chat_overview_page-2fbd5bbfb70c5623bd37ff7d6c41bf4d.png) +![](../../assets/chat_overview_page-2fbd5bbfb70c5623bd37ff7d6c41bf4d.png) 2. Enable **Firebase Notification** toggle on **Chat Overview** -![](../assets/firebase_notifications_toggle-5aeabfcbdc24cb8f1fea7d41d0e845fc.png) +![](../../assets/firebase_notifications_toggle-5aeabfcbdc24cb8f1fea7d41d0e845fc.png) 3. Enter your Firebase Credentials and press "Save". diff --git a/docusaurus/docs/Flutter/guides/end_to_end_chat_encryption.mdx b/docusaurus/docs/Flutter/05-guides/06-end_to_end_chat_encryption.mdx similarity index 99% rename from docusaurus/docs/Flutter/guides/end_to_end_chat_encryption.mdx rename to docusaurus/docs/Flutter/05-guides/06-end_to_end_chat_encryption.mdx index 8a463af4..10699b2d 100644 --- a/docusaurus/docs/Flutter/guides/end_to_end_chat_encryption.mdx +++ b/docusaurus/docs/Flutter/05-guides/06-end_to_end_chat_encryption.mdx @@ -1,9 +1,10 @@ --- id: end_to_end_chat_encryption -sidebar_position: 12 -title: End To End Chat Encryption +title: Encryption --- +Adding End To End Encryption to your Chat App + ## Introduction When you communicate over a chat application with another person or group, diff --git a/docusaurus/docs/Flutter/guides/error_reporting_with_sentry.mdx b/docusaurus/docs/Flutter/05-guides/07-error_reporting_with_sentry.mdx similarity index 98% rename from docusaurus/docs/Flutter/guides/error_reporting_with_sentry.mdx rename to docusaurus/docs/Flutter/05-guides/07-error_reporting_with_sentry.mdx index a192a613..dbbe312e 100644 --- a/docusaurus/docs/Flutter/guides/error_reporting_with_sentry.mdx +++ b/docusaurus/docs/Flutter/05-guides/07-error_reporting_with_sentry.mdx @@ -1,7 +1,6 @@ --- id: error_reporting_with_sentry -sidebar_position: 15 -title: Error Reporting With Sentry +title: Error Reporting --- Error Reporting With Sentry diff --git a/docusaurus/docs/Flutter/guides/adding_chat_to_video_livestreams.mdx b/docusaurus/docs/Flutter/05-guides/08-adding_chat_to_video_livestreams.mdx similarity index 97% rename from docusaurus/docs/Flutter/guides/adding_chat_to_video_livestreams.mdx rename to docusaurus/docs/Flutter/05-guides/08-adding_chat_to_video_livestreams.mdx index 9a2863b6..72f50120 100644 --- a/docusaurus/docs/Flutter/guides/adding_chat_to_video_livestreams.mdx +++ b/docusaurus/docs/Flutter/05-guides/08-adding_chat_to_video_livestreams.mdx @@ -1,7 +1,6 @@ --- id: adding_chat_to_video_livestreams -sidebar_position: 7 -title: Adding Chat To Video Livestreams +title: Livestreams Integration --- Adding Chat To Video Livestreams diff --git a/docusaurus/docs/Flutter/05-guides/08-migrations/_category_.json b/docusaurus/docs/Flutter/05-guides/08-migrations/_category_.json new file mode 100644 index 00000000..e30f7ae4 --- /dev/null +++ b/docusaurus/docs/Flutter/05-guides/08-migrations/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Migrations" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/guides/migration_guide_4_0.mdx b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_4_0.mdx similarity index 96% rename from docusaurus/docs/Flutter/guides/migration_guide_4_0.mdx rename to docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_4_0.mdx index 887cef3a..236bda99 100644 --- a/docusaurus/docs/Flutter/guides/migration_guide_4_0.mdx +++ b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_4_0.mdx @@ -1,12 +1,12 @@ --- id: migration_guide_4_0 -sidebar_position: 14 -title: Migration Guide v4.0 +sidebar_position: 1 +title: v4.0 --- **Version 4.0.0** of the Stream Chat Flutter SDK carries significant architectural changes to improve the developer experience by giving you more control and flexibility in how you use our core components and UI widgets. -This guide is intended to enumerate and better explain the changes in the SDK. +This v4.0 Migration Guide is intended to enumerate and better explain the changes in the SDK. If you find any bugs or have any questions, please file an [issue on our GitHub repository](https://github.com/GetStream/stream-chat-flutter/issues). We want to support you as much as we can with this migration. @@ -76,9 +76,9 @@ The automatic video compression when uploading a video has been removed. You can ### Slidable Channel List Item -The default slidable channel preview behavior has been removed. We have created a [guide](slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself. +The default slidable channel preview behavior has been removed. We have created a [guide](../../02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself. -![Slidable demo](../assets/slidable_demo.jpg) +![Slidable demo](../../assets/slidable_demo.jpg) ### Pin Permission @@ -194,13 +194,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called - Return/Create a new channel and start watching it. - Pause and Resume all subscriptions added to this composite. -For more information see the [`StreamChannelListView` documentation](../stream_chat_flutter/stream_channel_list_view.mdx). +For more information see the [`StreamChannelListView` documentation](../../03-stream_chat_flutter/stream_channel_list_view.mdx). ### ChannelsBloc to StreamChannelListController The `ChannelsBloc` widget should be replaced with `StreamChannelListController`. This controller provides all the functionality needed to query and manipulate channel data previously accessible through `ChannelsBloc`. -For more information see the [`StreamChannelListController` documentation](../stream_chat_flutter_core/stream_channel_list_controller.mdx). +For more information see the [`StreamChannelListController` documentation](../../04-stream_chat_flutter_core/stream_channel_list_controller.mdx). ### StreamChannelListView Examples @@ -310,13 +310,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called - Load more data using `loadMore`. - Refresh data. -For more information see the [`StreamMessageSearchListView` documentation](../stream_chat_flutter/stream_message_search_list_view.mdx). +For more information see the [`StreamMessageSearchListView` documentation](../../03-stream_chat_flutter/stream_message_search_list_view.mdx). ### MessageSearchBloc to StreamMessageSearchListController The `MessageSearchBloc` widget should be replaced with a `StreamMessageSearchListController`. This controller provides all the functionality needed to query and manipulate message search data previously accessible through `MessageSearchBloc`. -For more information see the [`StreamMessageSearchListController` documentation](../stream_chat_flutter_core/stream_message_search_list_controller.mdx). +For more information see the [`StreamMessageSearchListController` documentation](../../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx). ### StreamMessageSearchListView Example @@ -421,13 +421,13 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called - Set filters. - Refresh data. -For more information see the [`StreamUserListView` documentation](../stream_chat_flutter/stream_user_list_view.mdx). +For more information see the [`StreamUserListView` documentation](../../03-stream_chat_flutter/stream_user_list_view.mdx). ### UsersBloc to StreamUserListController The `UsersBloc` widget should be replaced with a `StreamUserListController`. This controller provides all the functionality needed to query and manipulate user data previously accessible through `UsersBloc`. -For more information see the [`StreamUserListController` documentation](../stream_chat_flutter_core/stream_user_list_controller.mdx). +For more information see the [`StreamUserListController` documentation](../../04-stream_chat_flutter_core/stream_user_list_controller.mdx). ### StreamUserListView Example @@ -558,7 +558,7 @@ The following arguments are newly introduced to the `StreamMessageInput`, and ar - `elevation`: elevation of the **StreamMessageInput** widget - `shadow`: **Shadow** for the **StreamMessageInput** widget -For more information see the [`StreamMessageInput` documentation](../stream_chat_flutter_core/stream_message_input_controller.mdx). +For more information see the [`StreamMessageInput` documentation](../../04-stream_chat_flutter_core/stream_message_input_controller.mdx). ### StreamMessageInput Examples diff --git a/docusaurus/docs/Flutter/guides/migration_guide_5_0.mdx b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_5_0.mdx similarity index 92% rename from docusaurus/docs/Flutter/guides/migration_guide_5_0.mdx rename to docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_5_0.mdx index 2a085e1f..3aa19a77 100644 --- a/docusaurus/docs/Flutter/guides/migration_guide_5_0.mdx +++ b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_5_0.mdx @@ -1,7 +1,7 @@ --- id: migration_guide_5_0 -sidebar_position: 15 -title: Migration Guide v5.0 +sidebar_position: 2 +title: v5.0 --- **Version 5.0.0** of the Stream Chat Flutter SDK UI package has been overhauled to support larger screen sizes better and provide native feeling web and desktop platform interactions that feel intuitive and expected. @@ -38,7 +38,7 @@ This section highlights our efforts on Desktop (macOS, Windows, and Linux) and W ### Setup -See the [setup guide](../stream_chat_flutter/setup.mdx) for platform specific instructions. +See the [setup guide](../../03-stream_chat_flutter/setup.mdx) for platform specific instructions. ### Supporting Larger Screens @@ -49,7 +49,7 @@ We've added support for larger screens and have made changes to the UI to suppor Below is an example running on macOS, with a split-screen view showing channels on the left and messages on the right. -![MacOS split](../assets/mac_os_split.png) +![MacOS split](../../assets/mac_os_split.png) ### Native Platform Interactions @@ -105,13 +105,13 @@ For additional information, see [#1125](https://github.com/GetStream/stream-chat The `StreamMemberListView` and `StreamMemberGridView` widgets are new widgets that allow you to display a list of members in a channel. -Check out the dedicated [documentation](../stream_chat_flutter/stream_member_list_view.mdx) for more information. +Check out the dedicated [documentation](../../03-stream_chat_flutter/stream_member_list_view.mdx) for more information. ### Attachment Picker As part of the v5 release, we've refactored the `AttachmentPicker` to be more flexible and customizable. This allows you to use the `AttachmentPicker` in various ways and customize the UI to your liking. -Check out the dedicated [guide](./customize_attachment_picker_modal.mdx) for more information. +Check out the dedicated [guide](../../02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx) for more information. ### Other Changes @@ -169,6 +169,6 @@ StreamImageAttachment( ) ``` -- Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](./autocomplete_triggers.mdx) to learn how to migrate your code. +- Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code. -- Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](./autocomplete_triggers.mdx) to learn how to migrate your code. +- Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code. diff --git a/docusaurus/docs/Flutter/05-guides/_category_.json b/docusaurus/docs/Flutter/05-guides/_category_.json new file mode 100644 index 00000000..14a4f173 --- /dev/null +++ b/docusaurus/docs/Flutter/05-guides/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Guides" +} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/basics/_category_.json b/docusaurus/docs/Flutter/basics/_category_.json deleted file mode 100644 index 76d33569..00000000 --- a/docusaurus/docs/Flutter/basics/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Introduction", - "position": 1 -} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/guides/_category_.json b/docusaurus/docs/Flutter/guides/_category_.json deleted file mode 100644 index cb58ac0d..00000000 --- a/docusaurus/docs/Flutter/guides/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Guides", - "position": 2 -} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/stream_chat_flutter/_category_.json b/docusaurus/docs/Flutter/stream_chat_flutter/_category_.json deleted file mode 100644 index 242afb7b..00000000 --- a/docusaurus/docs/Flutter/stream_chat_flutter/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Stream Chat Flutter", - "position": 3 -} \ No newline at end of file diff --git a/docusaurus/docs/Flutter/stream_chat_flutter_core/_category_.json b/docusaurus/docs/Flutter/stream_chat_flutter_core/_category_.json deleted file mode 100644 index 8d738e89..00000000 --- a/docusaurus/docs/Flutter/stream_chat_flutter_core/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Stream Chat Flutter Core", - "position": 4 -} \ No newline at end of file diff --git a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/guides/autocomplete_triggers.mdx b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/guides/autocomplete_triggers.mdx index 413d147a..50bfb6a0 100644 --- a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/guides/autocomplete_triggers.mdx +++ b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/guides/autocomplete_triggers.mdx @@ -7,7 +7,7 @@ Adding Custom Autocomplete Triggers ### Introduction -The [StreamMessageInput](../stream_chat_flutter/message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. +The [StreamMessageInput](../stream_chat_flutter/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property. By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones. diff --git a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_channel_list_view.mdx b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_channel_list_view.mdx index dbb3f266..258c0b64 100644 --- a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_channel_list_view.mdx +++ b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_channel_list_view.mdx @@ -23,7 +23,7 @@ ONLY the channels that the user is a part of. This section goes into setting up widget. :::note -Make sure to check the [StreamChannelListController](./stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. +Make sure to check the [StreamChannelListController](../stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`. ::: ### Basic Example diff --git a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_input.mdx b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_input.mdx index b60696ae..f6640f67 100644 --- a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_input.mdx +++ b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_input.mdx @@ -57,7 +57,7 @@ class ChannelPage extends StatelessWidget { It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget. :::note -Make sure to check the [StreamMessageInputController](./stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. +Make sure to check the [StreamMessageInputController](../stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`. ::: ### Adding Custom Actions diff --git a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx index cf27facf..91108b5e 100644 --- a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx +++ b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_message_search_list_view.mdx @@ -17,7 +17,7 @@ message they are searching for. As such, there needs to be a way to search for a channels. This is where `StreamMessageSearchListView` comes in. :::note -Make sure to check the [StreamMessageSearchListController](./stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. +Make sure to check the [StreamMessageSearchListController](../stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`. ::: ### Basic Example diff --git a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_user_list_view.mdx b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_user_list_view.mdx index 95bfbac9..6f424e38 100644 --- a/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_user_list_view.mdx +++ b/docusaurus/flutter_versioned_docs/version-4.x.x/Flutter/stream_chat_flutter/stream_user_list_view.mdx @@ -17,7 +17,7 @@ selecting users to add in a channel, etc. The `StreamUserListView` displays a li of users. :::note -Make sure to check the [StreamUserListController](./stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. +Make sure to check the [StreamUserListController](../stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`. ::: ### Basic Example