videojs / video.js

Video.js - open source HTML5 video player
https://videojs.com
Other
37.95k stars 7.44k forks source link

Please let me reorganize the events on the docs page #8893

Open rashadatjou opened 22 hours ago

rashadatjou commented 22 hours ago

Description

The current docs page is really confusing and hard to navigate. If possible I want to make only small adjustments to it where the events are listed under the appropriate section. So that we don't have multiple tap events but <section> – tap or <section>:tap which is much easier to read.

I just need the node of approval from a maintainer here and I will create a PR for this.

Thank you for working on VideoJS as it is the backbone of many videos on the internet <3

Reduced test case

https://docs.videojs.com/

Steps to reproduce

  1. Go to https://docs.videojs.com/
  2. Click on events
  3. Get confused on why there are repeating events

Errors

No errors.

What version of Video.js are you using?

8.19.1

Video.js plugins used.

None

What browser(s) including version(s) does this occur with?

Arc – Chromium 129.0.6668.101 (Official Build) (arm64)

What OS(es) and version(s) does this occur with?

macOS 14.7

welcome[bot] commented 22 hours ago

👋 Thanks for opening your first issue here! 👋

If you're reporting a 🐞 bug, please make sure you include steps to reproduce it. We get a lot of issues on this repo, so please be patient and we will get back to you as soon as we can. To help make it easier for us to investigate your issue, please follow the contributing guidelines.

gkatsev commented 22 hours ago

A PR would be appreciated, but I'm not sure how easy and maintainable it would be to change since this is all generated from jsdoc.