Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add new structure for ios-core docs #349

Merged
merged 21 commits into from
May 17, 2024
Merged

Conversation

shaunak-jagtap
Copy link
Contributor

@shaunak-jagtap shaunak-jagtap commented Apr 17, 2024

Description

Modified docs to match new (by-module) structure of web core

@shaunak-jagtap shaunak-jagtap self-assigned this Apr 17, 2024
Copy link

cloudflare-workers-and-pages bot commented Apr 22, 2024

Deploying dyte-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: e43bd96
Status: ✅  Deploy successful!
Preview URL: https://e0c6aa4c.dyte-docs.pages.dev
Branch Preview URL: https://ios-core-restructuring.dyte-docs.pages.dev

View logs

@shaunak-jagtap shaunak-jagtap marked this pull request as ready for review April 29, 2024 15:21
@shaunak-jagtap shaunak-jagtap changed the title WIP: add new structure for ios-core docs add new structure for ios-core docs Apr 29, 2024
@rohitkhirid
Copy link
Contributor

  • the subsection is not showing By module header
  • Quickstart page
  1. configure a DyteMeeting hyperlink not working
  2. Initialise Dyte meeting hyperlink not working
  3. Go live with your Dyte meeting hyperlink not working
  4. In swift package manager section, first point starts with 4
  5. In install the SDK, maybe we should extract out permissions and UI background modes section as it is common in both cocoapods and SPM
  6. In install the SDK, we are showing first option as cocoapods, shouldn't it be SPM as its more widely used.
  7. Initialise the SDK, participant event listener code is mentioned twice.
  8. at some placed we've added comments in callbacks, at some places there's actual code, we should stick to one practise only
  • Introduction
  1. It says android apps
  2. WebRTC functioning -> webrtc internals ?
  3. building a UI -> building an UI ?
  • Media Preview
  1. DyteSetupFragment ? DyteSettingsFragment ? I belive we don't have fragments on iOS
  2. audioEnabled -> meeting.localUser.audioEnabled ?
  3. videoEnabled -> meeting.localUser.videoEnabled ?
  • Handling Device Permissions
  1. we're using val from kotlin, I believe it should be let
  • Waiting Room
  1. The hyperlink on waiting room is not taking to proper page
  • Local user
  1. Event
    a. there is no such callback as called onRoomJoined in Dyte self events listener
  2. Introduction
    a. toggle audio video methods are mixed up

Copy link
Contributor

@swapnilmadavi swapnilmadavi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(suggestion): Currently, the DyteMobileClient's instance is referred to as both meeting and dyteMobileClient in different parts of the documentation. Can we follow a single term meeting throughout the docs?

docs/ios-core/pre-call/1-media-preview.mdx Outdated Show resolved Hide resolved
docs/ios-core/pre-call/1-media-preview.mdx Outdated Show resolved Hide resolved
docs/ios-core/pre-call/1-media-preview.mdx Outdated Show resolved Hide resolved
docs/ios-core/pre-call/1-media-preview.mdx Outdated Show resolved Hide resolved
docs/ios-core/participants/events.mdx Outdated Show resolved Hide resolved
docs/ios-core/participants/events.mdx Outdated Show resolved Hide resolved
docs/ios-core/plugins/introduction.mdx Outdated Show resolved Hide resolved
docs/ios-core/plugins/enable-plugin.mdx Outdated Show resolved Hide resolved
docs/ios-core/release-notes.mdx Outdated Show resolved Hide resolved
docs/ios-core/waiting-room.mdx Outdated Show resolved Hide resolved
# Introduction

The Dyte Core SDK is designed to provide you with an easy way to incorporate live video, voice, livestream and chat capabilities
into your Android apps. The Core SDK acts as a data-only layer. It provides simple APIs offering high-level primitives and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iOS apps.

Suggested change
into your Android apps. The Core SDK acts as a data-only layer. It provides simple APIs offering high-level primitives and
into your iOS apps. The Core SDK acts as a data-only layer. It provides simple APIs offering high-level primitives and

@shaunak-jagtap shaunak-jagtap merged commit ffebbfd into main May 17, 2024
2 checks passed
@shaunak-jagtap shaunak-jagtap deleted the ios-core-restructuring branch May 17, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants