AgoraIO / Docs-Source

A repository for the Agora Docs source content.
MIT License
20 stars 11 forks source link

Soft launch content review - Web #56

Closed lemon-chen closed 2 years ago

lynnfirst commented 2 years ago
image
lynnfirst commented 2 years ago
image

Can't see how to fix this. After the soft launch. @Mr-spShuvo

dengyaxi commented 2 years ago

The Video Calling product overview needs refinement. Why put "Call Recording" as the first feature (actually it should not be regarded as a sub-feature of RTC products)? Why "High-quality video at scale" and "AI-powered audio enhancement" have the same description

image

@divanov11 is looking at this.

lynnfirst commented 2 years ago

image

lynnfirst commented 2 years ago

image

@Mr-spShuvo, numbering is not working correctly with conditional text. Can you have a look at this after the soft release please.

dengyaxi commented 2 years ago

For the "Supported platforms“ doc:

  1. Information structure It takes some effort to find out that it actually apply to Android, iOS, and Web. For a doc that applies to all platforms, can we remove the platform selector on the top? Or at least, specify that the "Platforms" section is for Native (and incoming frameworks), and the "Browsers" section is for Web. Otherwise it's easy to get lost and confusing.

Besides, the doc title should be changed to "Supported platforms and browsers”

image
  1. Format issues image
dengyaxi commented 2 years ago

"v3.xs" might be confusing. Can we avoid the plural, and just use v3.x and v4.x?

image

Excellent. That is me saving a file old school and the text is added to a variable. Nice sspot, thank you.

dengyaxi commented 2 years ago

“Known Issues and Workarounds” is missing

This doc provides important information. Should add it back https://docs.agora.io/en/Video/web_sdk_known_issues?platform=Web

Lets talk after the soft launch. I think this should be in the release notes.

dengyaxi commented 2 years ago

Fix heading throughout "Release notes"


image
dengyaxi commented 2 years ago

Missing docs under "Develop"

dengyaxi commented 2 years ago

"Ensure call quality"

  1. How is echo cancellation related to audio and voice effects? image
billy-the-fish commented 2 years ago

https://github.com/AgoraIO/Docs-Source/pull/64

dengyaxi commented 2 years ago

"Manage your Agora account“ misses important information

The two warnings in https://docs.agora.io/en/Agora%20Platform/manage_projects?platform=All%20Platforms#switch-to-a-new-primary-certificate are gone, which should NOT happen because inappropriate certificate-related operations can break the availability of Agora services

image image
shahriarpshuvo commented 2 years ago

Hi Yaxi. I've tried this on before with Docusaurus Admonitions https://docusaurus.io/docs/markdown-features/admonitions. If you can, please try this. If this doesn't work, let me know, I will connect with after the Soft Launch about this Regard, Shahriar

On Wed, Aug 3, 2022 at 1:02 PM Yaxi @.***> wrote:

"Manage your Agora account“ misses important information

The two warnings in https://docs.agora.io/en/Agora%20Platform/manage_projects?platform=All%20Platforms#switch-to-a-new-primary-certificate are gone, which should NOT happen because inappropriate certificate-related operations can break the availability of Agora services

[image: image] https://user-images.githubusercontent.com/73678648/182544716-fcec4927-0cb3-42ea-a2ff-95699e932ce2.png

[image: image] https://user-images.githubusercontent.com/73678648/182544715-44cef1f6-6f00-47e3-9a2d-4728fad846d9.png

— Reply to this email directly, view it on GitHub https://github.com/AgoraIO/Docs-Source/issues/56#issuecomment-1203564053, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFLF2QRJP4IZVYY6VYKPWYLVXIKQXANCNFSM55JQBAGQ . You are receiving this because you were mentioned.Message ID: @.***>

dengyaxi commented 2 years ago

What's the plan for "Media Processing Extensions" docs

Features such as noise reduction and virtual background are offered through extensions (independent npm packages). To use these features, developers need to integrate both the SDK and the extension.

See https://docs.agora.io/en/Video/virtual_background_web_ng?platform=Web

dengyaxi commented 2 years ago

"Implement product workflow" can be improved

The current title is not that straightforward, and the doc content seems like a loose combination of features. Also, not sure if it's logically sound to define screen sharing--adjust volume---mute/unmute as a "common workflow"

dengyaxi commented 2 years ago

Can we improve the way of presenting docs that only apply to certain platforms

For example, "Play media files in a channel" and "Implement raw video and audio processing" do not apply to Web. Currently, users will not find this until they see the "Implement xx" section. Need to give such reminders in the beginning of the doc

image
dengyaxi commented 2 years ago

ILS pricing doc needs to include "Standard low latency"

ILS Standard actually charges lower than ILS Premium (see https://docs.agora.io/en/live-streaming/billing_live_standard?platform=Web#unit-price). The current pricing doc does not reflect the pricing difference between Standard low latency and Premium ultra-low latency (as described in product overview)

dengyaxi commented 2 years ago

Hi Yaxi. I've tried this on before with Docusaurus Admonitions https://docusaurus.io/docs/markdown-features/admonitions. If you can, please try this. If this doesn't work, let me know, I will connect with after the Soft Launch about this Regard, Shahriar On Wed, Aug 3, 2022 at 1:02 PM Yaxi @.> wrote: "Manage your Agora account“ misses important information The two warnings in https://docs.agora.io/en/Agora%20Platform/manage_projects?platform=All%20Platforms#switch-to-a-new-primary-certificate are gone, which should NOT happen because inappropriate certificate-related operations can break the availability of Agora services [image: image] https://user-images.githubusercontent.com/73678648/182544716-fcec4927-0cb3-42ea-a2ff-95699e932ce2.png [image: image] https://user-images.githubusercontent.com/73678648/182544715-44cef1f6-6f00-47e3-9a2d-4728fad846d9.png — Reply to this email directly, view it on GitHub <#56 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFLF2QRJP4IZVYY6VYKPWYLVXIKQXANCNFSM55JQBAGQ . You are receiving this because you were mentioned.Message ID: @.>

I tried and it doesn't seem to work properly. It would be great if you can look into this after soft launch. Thanks!

image