wavesurfer.js icon indicating copy to clipboard operation
wavesurfer.js copied to clipboard

feature request: certain docs would benefit from table of contents

Open Johnrobmiller opened this issue 1 year ago • 2 comments

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

Maintainers ought to update documentation to reflect this.

Johnrobmiller avatar Apr 28 '24 17:04 Johnrobmiller

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 avatar Apr 29 '24 16:04 Johnrobmiller

@Johnrobmiller better to add this as a discussion feature request item here https://github.com/katspaugh/wavesurfer.js/discussions

entonbiba avatar Jul 13 '24 00:07 entonbiba

https://wavesurfer.xyz/plugins/ is an old page for v6. I've added a banner there to link to the new docs and examples.

The information on how to install with npm is right on top of the readme: https://github.com/katspaugh/wavesurfer.js?tab=readme-ov-file#getting-started

However, I agree a table of contents would be helpful.

katspaugh avatar Dec 25 '24 09:12 katspaugh