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

[expo-video] Add expo-video docs page #27854

Merged
merged 2 commits into from Mar 27, 2024
Merged

Conversation

behenate
Copy link
Member

Why

Expo-video is missing a docs page.

ENG-11349

How

Renamed the video.mdx to video-av.mdx and assigned video.mdx as expo-video docs page. We should consider doing this the other way around (adding a suffix to expo-video file). Current way might create issues with linking to the docs, eg. if someone wants to redirect people to the latest expo-av video docs so they would link to https://docs.expo.dev/versions/latest/sdk/video/, but the users will be redirected to expo-video docs after SDK 51. I kept it this way in case we believe people should be redirected to expo-video anyways. Let me know what you think about it :)

Created a simple example for expo-video (similar to the expo-av example), which showcases how to use player properties and events.

Test Plan

Tested by running the docs locally

@expo-bot expo-bot added the bot: suggestions ExpoBot has some suggestions label Mar 25, 2024
@behenate behenate marked this pull request as ready for review March 25, 2024 18:01
@expo-bot
Copy link
Collaborator

expo-bot commented Mar 25, 2024

📘 Your docs preview website is ready!

docs/pages/versions/unversioned/sdk/video-av.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
@behenate behenate force-pushed the @behenate/expo-video-docs-page branch 2 times, most recently from 883cf5d to 653c23e Compare March 26, 2024 09:56
@Simek
Copy link
Collaborator

Simek commented Mar 26, 2024

Few things to address:

  • export missing VolumeEvent, PlayerError, EventName and DRMOptions types
  • add return types to PiP methods, they are marked in docs now as returning any
  • fix the emit, addListener, removeListener and removeAllListeners params typing - now we output a bogus type for those
  • mark as not linkable, or export missing definition for SharedObject

@behenate behenate force-pushed the @behenate/expo-video-docs-page branch 2 times, most recently from 2e96888 to 3c84e81 Compare March 26, 2024 14:51
@expo-bot expo-bot added bot: passed checks ExpoBot has nothing to complain about and removed bot: suggestions ExpoBot has some suggestions labels Mar 26, 2024
@behenate behenate force-pushed the @behenate/expo-video-docs-page branch from 3c84e81 to 8c59b87 Compare March 26, 2024 15:16
Copy link
Collaborator

@Simek Simek left a comment

Choose a reason for hiding this comment

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

Thanks for the updates! 👍

As discussed offline, we will be working further to improve those docs in near future, but it's definitely a great start!

docs/pages/versions/unversioned/sdk/video-av.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video-av.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
docs/pages/versions/unversioned/sdk/video.mdx Outdated Show resolved Hide resolved
packages/expo-video/src/VideoView.tsx Outdated Show resolved Hide resolved
Copy link
Member

@amandeepmittal amandeepmittal left a comment

Choose a reason for hiding this comment

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

Thank you adding this doc and for incorporating those changes

@behenate behenate merged commit e4c1352 into main Mar 27, 2024
13 of 14 checks passed
@behenate behenate deleted the @behenate/expo-video-docs-page branch March 27, 2024 11:22
@brentvatne brentvatne added the published Changes from the PR have been published to npm label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: fingerprint compatible bot: passed checks ExpoBot has nothing to complain about preview published Changes from the PR have been published to npm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants