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

feature request: certain docs would benefit from table of contents #3677

Open
Johnrobmiller opened this issue Apr 28, 2024 · 1 comment
Open
Labels

Comments

@Johnrobmiller
Copy link
Contributor

Johnrobmiller commented Apr 28, 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.

@Johnrobmiller
Copy link
Contributor Author

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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant