Missing documentation

Open gustavo-salazar opened this issue 2 years ago • 2 comments

The new website/storybook is missing some documentation. Some of it we had in v3.

[ ] change events in tracks.
[ ] How to use Mixins, specifically the methods to override for withZoom and withHighlight.
[ ] What to do if using canvas but still wanting to use withZoom
[x] How to use nightingale components from CDN
[x] How to create a new component

Mar 23 '23 14:03 gustavo-salazar

I would also say that the documentation is sparse to the point of not being useable by people outside of the EBI. As an example the nightingale-msa docs do not list which package(s) to import. Nor does it even explain what format the sequences must be in or how to pass them such data to the element. Am I supposed to assume this works like [plotly/react-msa-viewer](https://github.com/plotly/react-msa-viewer? Compare this to the initial examples for nightingale-sequence where passing data is quite obviously handled with the sequence attribute.

Take for instance, nightingale-track. This takes and attribute called layout. What is this? A string? An array? An object with some defined layout. I guess we'll never know.

Jun 08 '23 11:06 DanBuchan