Please let me reorganize the events on the docs page

[rashadatjou]

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]

👋 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]

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.

[rashadatjou]

@gkatsev thanks for replaying. I will keep that in mind while trying to figure out a solution for this. What tooling do you guys use to generate the docs from JSDoc?

[mister-ben]

video.js/package.json

Line 72 in d2b9d5c

"docs:api": "jsdoc -c .jsdoc.js",

The jsdoc config here: https://github.com/videojs/video.js/blob/main/.jsdoc.js

The theme is https://github.com/ankitskvmdam/clean-jsdoc-theme. The theme author was very responsive to another issue I raised, if it's something that needs to be addressed there.

[rashadatjou]

@mister-ben and @gkatsev It seems someone already opened the issue/request to have better content structuring in the sidebar ankitskvmdam/clean-jsdoc-theme#203. I will try to update our underlying dependency which is clean-docs and add the much needed @subcategory param to it.

Hopefully this way we can just indicate in what subcategory each Event belongs to. For example adding the @subcategory { Tech } to the an event like usage will host it under the Tech subcategory:

Events 
    -- Tech 
        -- usage 

This seems as an clear and intuitive way to update the docs without breaking anything currently that is the VideoJS docs.