I encountered the following issues working with the docs:
- Typo in docs: “Did pip mode was triggered by click event”
- I had a hard time to find basic info like the properties for current time. What might help:
- More obvious link to documentation from README.md (now it's under the somewhat cryptic name "Modules")
- Deeplinks to most relevant content, e.g. to properties and events
- Docs on start/end/duration only states that these fields a number - so I still don’t know if it’s sec or msec
- It would be good to add basic human explanation to often used, yet non-standard fields - e.g. what's the difference between "currentRelativeTime" and "currentTime"?
- It would be more helpful if the docs would explain what to use fields for (business terms) instead of restating what it is. For example, videoContainerRef states "Storing wrapper ref of the videoPlayer", which I could have derived from the name myself (well, actually I'd have expected it to be ref to the container - not to the player as the doc says). But it doesn't say what I can do with it - or a link to an example (playbook?) how to use it.
- Add a higher level explanation (aside the detailed API docs). Things became clear to me once I understood that this basically adds a layer on top similar to React's virtual DOM (video element being too slow; so there is a virtual video-player with which the code can easily interact)
- Formatting of code sample in README is incorrect (space vs tab):
I encountered the following issues working with the docs: