Missing documentation

[gustavo-salazar]

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
• How to use nightingale components from CDN
• How to create a new component

[DanBuchan]

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.

[vincerubinetti]

I would also say that the documentation is sparse to the point of not being useable by people outside of the EBI.

I'd have to agree. Sparse and also incorrect in many cases. I'm trying to integrate this component into a modern React app and have immediately ran into many many issues:

• React example incorrect (customElements.whenDefined is async)
• Can't search docs for keywords, only top-level page names, it seems (though this may be more of a shortcoming of Storybook)
• Can't get interpro-track to respect height
• Had to dig into the storybook source code to find these lines that show you have to pass a contributors prop to get the interpro-track to display separate rows... this prop is not mentioned anywhere in the docs. I would've thought non-overlapping layout could be used to achieve that...
• Can't find a way to get type definitions working for the custom component attributes. Wish the types of each component were exported or able to be extracted somehow. The best I could come up with is: const sequenceProps: Partial<NightingaleSequence> = {}; then <nightingale-sequence {...sequenceProps} />. Had to do Partial or else I'd need to provide all the internal private methods and such, but that also makes it miss any required attributes.
• Types are just wrong in several places, like layout being undefined, and name not being in InterProFeature in contributors.

This makes me very nervous to use this library in production. It feels in alpha stages, at best. Which is fine; time and resources are hard to come by... except that protvista was officially deprecated, when its replacement is not in a state that is ready to be used.