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

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

Open
rashadatjou opened this issue Oct 11, 2024 · 4 comments
Open

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

rashadatjou opened this issue Oct 11, 2024 · 4 comments

Comments

@rashadatjou
Copy link

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

@rashadatjou rashadatjou added the needs: triage This issue needs to be reviewed label Oct 11, 2024
Copy link

welcome bot commented Oct 11, 2024

👋 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
Copy link
Member

gkatsev commented Oct 11, 2024

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.

@mister-ben mister-ben removed the needs: triage This issue needs to be reviewed label Oct 11, 2024
@rashadatjou
Copy link
Author

@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
Copy link
Contributor

"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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants