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

Documentation is not sufficient to replicate examples #261

Closed
DanBuchan opened this issue Jun 15, 2023 · 2 comments
Closed

Documentation is not sufficient to replicate examples #261

DanBuchan opened this issue Jun 15, 2023 · 2 comments

Comments

@DanBuchan
Copy link

DanBuchan commented Jun 15, 2023

Documentation is generally very poor outside the use case of nightingale-sequence and the "getting started" examples at ebi-webcomponents.github.io.

For instance, https://ebi-webcomponents.github.io/nightingale/?path=/story/components-tracks-alignments-readme--page does not explain how to pass an MSA to the component, nor does it explain what format this data should be in.

@gustavo-salazar
Copy link
Contributor

Thanks for reporting it.
As you can see from #249 the documentation is still a work in progress, but unfortunately, the time we can dedicate to the project is limited. I hope to be able to get to it soon. PRs are also very welcome!

In the meantime, you can see the structure of the data in the storybook example: https://github.com/ebi-webcomponents/nightingale/blob/main/stories/10.MSA/NightingaleMSA.stories.ts

@DanBuchan
Copy link
Author

No worries. Looking forward to the docs being more complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants