Skip to content

Conversation

@EtayM
Copy link
Collaborator

@EtayM EtayM commented Nov 11, 2025

Transitioned Dynamic Metadata article from Help Center to the docs.

Copy link
Contributor

@Bradez Bradez left a comment

Choose a reason for hiding this comment

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

@EtayM can you look into whether Docusaurus supports video playback (webm (preferred) or mp4)?

It would be better to have the uploading-media-files.gif be a video stream wherein we can have the video playback controls inside the documentation. This way, it lets people "click" to play it (from the start) but also stop/start and scrub through as they require.

If not, we can proceed with using a gif but it would be good to check whether it's supported and start using video formats going forward so user's viewing the documentation have the flexibility to control the playback which is especially relevant for long-form playback (as is the case with this gif).

Further, because of how gif works the file size is (unnecessarily) large which can unnecessarily consume bandwidth on devices with data limits.

@EtayM
Copy link
Collaborator Author

EtayM commented Nov 12, 2025

@Bradez Yeah, Docusaurus uses MDX, so we can embed videos with the HTML <video> tag.
I've tried this:

<video autoplay loop muted playsinline width="100%">
  <source src="/img/guides/advanced-mechanics/uploading-media-files.webm" type="video/webm" />
  Sorry, your browser doesn't support embedded videos.
</video>

but for some reason it didn't autoplay on my browser (chrome).
So to ensure it autoplays, I've created a React component that wraps the video tag and uses a useEffect hook to manually call .play() on the video element as soon as the component loads.

Couple notes though:

  • Looks like webm isn't supported on Safari. Should we use mp4 files instead?
  • There's lots of other gifs that we should convert to webm or mp4 at some point

@Bradez
Copy link
Contributor

Bradez commented Nov 13, 2025

@EtayM we don't necessarily need auto-play as that's one of the problems with GIF. Unless the image is right at the top of the page, or only autoplays once it's first in the focus of the user, I think it's safe to have it no autoplay.

As for webm vs mp4: I still can't believe in 2025 Safari and iOS are lacking on this front. Insane. However, based on that information, we should definitely go for the more compatible type—mp4.

Finally, to answer your question regarding other GIF files. Yes, let's ticket a task to get those updated. No major urgency, but it's definitely better we do that. Further, it gives us another opportunity to redo the recordings to bring it up to speed with the latest interface designs as I'm sure there are various GIFs (along with static images) that are based on outdated application designs.

@EtayM
Copy link
Collaborator Author

EtayM commented Nov 16, 2025

@Bradez Ok, I've removed the AutoPlay component and now using video tag with mp4 file, everything looks good to me.

@Bradez Bradez merged commit cb026ee into master Nov 17, 2025
1 check passed
@Bradez Bradez deleted the docs/ECO-572/dynamic-metadata branch November 17, 2025 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants