Skip to content

Commit

Permalink
fix: introduction cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
palashgo committed Jan 27, 2024
1 parent b903653 commit 1e7e41f
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 90 deletions.
5 changes: 3 additions & 2 deletions docs/android-core/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ completed the steps in the
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand All @@ -51,6 +50,7 @@ You must complete the following steps:

:::tip Note
If your app targets to lower versions of android (android api <= 24), Please enable core desugering in your app's build.gradle file like follows.

```
android {
// other configurations
Expand All @@ -65,6 +65,7 @@ dependencies {
coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.0.4")
}
```

:::

## Step 2: Initialize the SDK
Expand Down Expand Up @@ -137,4 +138,4 @@ dyteClient.leaveRoom({
}, {
// leave failed
})
```
```
5 changes: 3 additions & 2 deletions docs/android/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ completed the steps in the
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand All @@ -46,6 +45,7 @@ You must complete the following steps:

:::tip Note
If your app targets to lower versions of android (android api <= 24), Please enable core desugering in your app's build.gradle file like follows.

```
android {
// other configurations
Expand All @@ -60,6 +60,7 @@ dependencies {
coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.0.4")
}
```

:::

## Step 2: Initialisation configuration
Expand Down Expand Up @@ -101,4 +102,4 @@ dyteUIKit.startMeeting()

![meeting UI screenshot with labeled parts](/static/mobile/0.x.x/mobile-setup.png)
![meeting UI screenshot with labeled parts](/static/mobile/0.x.x/mobile-meeting.png)
![meeting UI screenshot with labeled parts](/static/mobile/0.x.x/mobile-meeting-options.png)
![meeting UI screenshot with labeled parts](/static/mobile/0.x.x/mobile-meeting-options.png)
1 change: 0 additions & 1 deletion docs/flutter-core/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ You'll learn how to:
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:
- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand Down
58 changes: 10 additions & 48 deletions docs/flutter/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,21 @@ slug: /

Dyte's Flutter UI Kit is a prebuilt design library of UI components that makes it easy to integrate video and voice calls into any Flutter app within minutes.

## The Anatomy of Flutter UI Kit
## Usage

The UI Kit is a design library of prebuilt UI components built on top of the [Flutter Core SDK](/flutter-core). Core SDK handles all the low-level complexities such as media and network handling parts of a meeting and exposes easy-to-use developer friendly APIs. The idea is to make pass a flutter meeting client to a component that you want to change as per your design.
The UI Kit under the hood works on top of the same Core SDK that is publicly available. Core SDK handles all the low-level media and network handling parts
of a meeting and exposes methods and properties that the UI Kit uses

<img
src="/static/ui-kit/1.x.x/atomic-design.svg"
width="800"
height="600"
alt="grid-uikit"
className="comps-uikit"
/>
Uses a layered design structure, allowing you to start with one prebuilt component and slowly go down layers and add custom UI incrementally as your needs evolve.

Uses a layered design structure, allowing you to start with one prebuilt component and slowly add further layers as the needs evolve. For example, you can create a full fledged meeting experience using just one UI component, `DyteUIKit`. The `DyteUIKit` component contains all the necessary features and subcomponents to create a default meeting UI.
- **Use prebuilt component**: You can use prebuilt component to
create your meeting quickly. With this component, you don't have to handle all
the states, dialogs, and other aspects of managing the application. The UI kit
also respect your permissions and theming configuration from the preset.

## How to use Flutter UI Kit?
For more information, see [UI Kit Quickstart](/flutter/quickstart).

Dyte's UI Kit offers a couple of ways to get started with your live video and voice calling applications:

- **Use prebuilt components**: You can use prebuilt `DyteUIKit` component to create your meeting quickly. With this component, you don't have to handle all the states, dialogs, and other aspects of managing the application. The UI kit also respect your permissions and theming configuration from the preset.

For more information, see [Flutter UI Kit Quickstart](/flutter/quickstart).

- **Build UI as per your theme**: Dyte also offers the flexibility to implement your in-house themes to Dyte UI kit. This offers a customization option to improve user experience on your app.

## Components of `DyteUIKit`

DyteUIKit can be broken down into three components:

### DyteMeetingInfo

This contains all the info you pass onto DyteUIKit to get all the permissions and layout as per your presets. To know how to do this, head over to [Initialize the SDK](/flutter-core#step-2-initialize-the-sdk).

### Design Token/Configurations

This gives you an option to set theme of DyteUIKit as per your convenience. This contains majorly three subcomponents:

- baseBackground
- basePrimary
- textColor

### clientContext

This is required to setup the context and handle the navigation routes for your app.
- **Mix and match**: Use some components from our component library, build some custom components yourself.

## Supported Versions

Expand All @@ -70,13 +42,3 @@ In iOS, for downloading attachments in chat, add the following permissions in yo
<key>UIFileSharingEnabled</key>
<true/>
```

## Features

Dyte UI Kit is built with a strong pyramid-like architecture of [components/widgets](https://docs.flutter.dev/ui/widgets-intro) in a bottom-up fashion, with all the base widgets at it's bottom and building specific widgets as we move towards the top using the base classes, giving room for peak customization.
Dyte UI Kit gives you the following advantages:

- **Minimizing SDK Size**: Dyte SDK adds mere 4-5 MBs to your app which will give you smooth audio/video calling experience along with chats, polls, plugins, host controls, recording and a lot more.
- **Fast**: The architectural decisions ploughed our SDK in a great way. Building extremely usable and custom components at every step of UI rendering with maximum flexibility, be it a just a Text widget or a whole Control Bar, which in-turn made our SDK lightening fast.
- **Third-party dependencies**: There are almost no third-party dependencies and most of our features are developed in-house to give you the room for maximum flexibility and include no unnecessary functions to burden your application on bandwidth or size.
- **Customizable design token**: Customization with design tokens has been made super easy just for you to tone UI Kit as per your theme and give an enriching experience to your costumers.
1 change: 0 additions & 1 deletion docs/flutter/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ completed the steps in the
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand Down
1 change: 0 additions & 1 deletion docs/guides/capabilities/misc/embed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ You simply need to add a small piece of HTML code to your website or application
## Before Getting Started

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand Down
5 changes: 2 additions & 3 deletions docs/ios-core/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ You'll learn how to:
[Integrate Dyte](/getting-started#integrate-dyte) section.
You must complete the following steps:
- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participant](/api/?v=v2#/operations/add_participant)
Expand Down Expand Up @@ -109,7 +108,7 @@ Sources: Apple Developer Documentation: [Declaring Your App's Supported Backgrou
let meeting = DyteiOSClientBuilder().build()
```

2. Add listeners and implement callback stubs.
2. Add the required listeners and implement callback stubs as per requirement

```swift
meeting.addMeetingRoomEventsListener(meetingRoomEventsListener: self)
Expand All @@ -135,7 +134,7 @@ Add `authToken` that you got from the REST API to constructor of DyteMeetingInfo
let meetingInfo = DyteMeetingInfoV2(authToken: authToken,
enableAudio: true,
enableVideo: true,
baseUrl: Constants.BASE_URL)
baseUrl: "https://api.dyte.io/v2")
```

## Step 4: Initialize the connection request
Expand Down
18 changes: 9 additions & 9 deletions docs/ios/intro-ios-uikit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ slug: /

Dyte's iOS UI Kit is a prebuilt design library of UI components that makes it easy to integrate video and voice calls into any iOS app within minutes.

## The Anatomy of iOS UI Kit
## Usage

The UI Kit is a design library of prebuilt UI components built on top of the [iOS Core SDK](/iOS-core). Core SDK handles all the low-level complexities such as media and network handling parts of a meeting and exposes easy-to-use developer friendly APIs. The idea is to make pass a iOS meeting client to a component that you want to change as per your design.
The UI Kit under the hood works on top of the same Core SDK that is publicly available. Core SDK handles all the low-level media and network handling parts
of a meeting and exposes methods and properties that the UI Kit uses

Uses a layered design structure, allowing you to start with one prebuilt component and slowly add further layers as the needs evolve. For example, you can create a full fledged meeting experience using just one UI component, `DyteUIKit`. The `DyteUIKit` component contains all the necessary features and subcomponents to create a default meeting UI.
Uses a layered design structure, allowing you to start with one prebuilt component and slowly go down layers and add custom UI incrementally as your needs evolve.

## How to use iOS UI Kit?

Dyte's UI Kit offers a couple of ways to get started with your live video and voice calling applications:

- **Use prebuilt components**: You can use prebuilt `DyteUIKit` component to create your meeting quickly. With this component, you don't have to handle all the states, dialogs, and other aspects of managing the application. The UI kit also respect your permissions and theming configuration from the preset.
- **Use prebuilt component**: You can use prebuilt component to
create your meeting quickly. With this component, you don't have to handle all
the states, dialogs, and other aspects of managing the application. The UI kit
also respect your permissions and theming configuration from the preset.

For more information, see [iOS UI Kit Quickstart](/iOS/quickstart).

- **Build UI as per your theme**: Dyte also offers the flexibility to implement your in-house themes to Dyte UI kit. This offers a customization option to improve user experience on your app.
- **Mix and match**: Use some components from our component library, build some custom components yourself
1 change: 0 additions & 1 deletion docs/ios/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ completed the steps in the
You must complete the following steps:

- Create a [Dyte Developer Account](https://dev.dyte.io/)
- Create [Presets](https://dev.dyte.io/roles-presets)
- Create a
[Dyte Meeting](/api/?v=v2#/operations/create_meeting)
- [Add Participants](/api/?v=v2#/operations/add_participant)
Expand Down
29 changes: 7 additions & 22 deletions docs/rn-ui-kit/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,21 @@ image: /static/ui-kit/1.x.x/ui-kit-cover.jpg
Dyte's React Native UI Kit is a prebuilt design library of UI components that makes it
easy to integrate video and voice calls into any app or website within minutes.

## The Anatomy of React Native UI Kit
## Usage

The UI Kit is a design library of prebuilt UI components built on top of the
core SDKs. Core SDK handles all the low-level media and network handling parts
of a meeting and exposes simpler APIs to use. You can create a meeting object
using the web-core components and pass it to the UI Kit components.
The UI Kit under the hood works on top of the same Core SDK that is publicly available. Core SDK handles all the low-level media and network handling parts
of a meeting and exposes methods and properties that the UI Kit uses

- Uses a layered design structure, allowing you to start with one prebuilt
component and slowly add further layers as the needs evolve.
- Includes a number of [Hooks](https://beta.reactjs.org/reference/react). Hooks
enable you to use various React features from your components. For more
information, see [Use React Native Core Hooks](/react-native/using-hooks).
Uses a layered design structure, allowing you to start with one prebuilt component and slowly go down layers and add custom UI incrementally as your needs evolve.

## How to Use React Native UI Kit?

Dyte's UI Kit offers a couple of ways to get started with your live video and
voice calling applications.

- **Use prebuilt components**: You can use prebuilt `DyteMeeting` component to
- **Use prebuilt component**: You can use prebuilt component `<DyteMeeting />` to
create your meeting quickly. With this component, you don't have to handle all
the states, dialogs, and other aspects of managing the application. The UI kit
also respect your permissions and theming configuration from the preset.

For more information, see [React Native UI Kit Quickstart](/react-native/quickstart).
For more information, see [UI Kit Quickstart](/react-native/quickstart).

- **Build your own UI**: Dyte also offers the flexibility to build your own UI
using various individual components. This offers limitless customization
options, ranging from colors and font to spacing, participant tiles, screen
share views, logo, height, width and more, you can tailor the UI to fit your
exact needs. See Build your own UI section.
- **Mix and match**: Use some components from our component library, build some custom components yourself. Read the [basics of our component design](/react-native/basics/components-basics) and checkout the [gallery of available components](/react-native/components)

## Supported Devices

Expand Down

0 comments on commit 1e7e41f

Please sign in to comment.