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

Initial docs update before v5 #335

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Initial docs update before v5 #335

merged 1 commit into from
Jul 11, 2024

Conversation

jakobnissen
Copy link
Member

Remove tutorial - Vamb's Python interface has been internal since v4, and I really don't want to keep it up to date. That takes too much time. Add new sections in Documentation, and move some material from the README to these doc pages.
Small tweaks to the documentation.

The docs are not done yet, grep for "TODO" before v5 launch, including:

  • No link to TaxVamb preview in README
  • No description of how to run AVAMB and TaxVamb
  • No description of the Taxonomy input to TaxVamb or Taxometer

Remove tutorial - Vamb's Python interface has been internal since v4, and I
really don't want to keep it up to date. That takes too much time.
Add new sections in Documentation, and move some material from the README to
these doc pages.
Small tweaks to the documentation.

The docs are not done yet, grep for "TODO" before v5 launch, including:
* No link to TaxVamb preview in README
* No description of how to run AVAMB and TaxVamb
* No description of the Taxonomy input to TaxVamb or Taxometer
@jakobnissen jakobnissen merged commit 7dc2f98 into master Jul 11, 2024
6 checks passed
@jakobnissen jakobnissen deleted the docs branch July 11, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant