You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As the title says, there is no information on how to install plugins for most users. I say "for must users" because there is, technically speaking, documentation on how to install them using <script> tags (https://wavesurfer.xyz/plugins/). However, probably nearly all devs these days use frameworks like next.js that do not use <script> tags. Therefore, for almost all users, the docs are incomplete and users have no way of knowing how to install plugins.
Maintainers ought to update documentation to reflect this.
The text was updated successfully, but these errors were encountered:
EDIT: I see that further down in those docs there actually is information on to use plugins in NPM.
In that case, it might be helpful to introduce some table of contents, sidebar, etc., anything that gives the reader an idea of what is contained within the docs. Users do not read docs from top to bottom, and if they skim the docs they might miss key information as I did.
Johnrobmiller
changed the title
Docs incomplete: no information about how to install plugins for most users
feature request: certain docs would benefit from table of contents
May 1, 2024
As the title says, there is no information on how to install plugins for most users. I say "for must users" because there is, technically speaking, documentation on how to install them using <script> tags (https://wavesurfer.xyz/plugins/). However, probably nearly all devs these days use frameworks like next.js that do not use <script> tags. Therefore, for almost all users, the docs are incomplete and users have no way of knowing how to install plugins.
Maintainers ought to update documentation to reflect this.
The text was updated successfully, but these errors were encountered: