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

Implement top-bar navigation for relevant BioJulia packages #6

Open
M-PERSIC opened this issue Jul 17, 2023 · 0 comments
Open

Implement top-bar navigation for relevant BioJulia packages #6

M-PERSIC opened this issue Jul 17, 2023 · 0 comments
Labels
high priority Needs to be resolved as soon as possible

Comments

@M-PERSIC
Copy link
Member

M-PERSIC commented Jul 17, 2023

Is your feature request related to a problem? Please describe.
A top-bar would serve to both categorize and highlight relevant packages (link to their documentation pages) that are either part of the BioJulia ecosystem or are crucial for common biology applications.

Such packages should be included based on their relevance in their respective domain as well as their overall quality, to-be-determined by the community.

Describe the solution you'd like
SciMLDocs renders a top bar via MultiDocumenter.jl. I am also tracking native top-bar navigation support for Documenter.jl

It might be of interest to include sub-categories with packages grouped according to subject (biology, biochemistry, genetics, ecology,..) as well as whether they are considered third-party, meaning outside of BioJulia.

A draft outline in no particular order

  • Core
    • Sequencing libraries (BioSymbols,...)
  • Modelling
    • Simulations (EcoSISTEM,...)
  • Analysis
    • Plots and Visualization (BioMakie,...)
  • Research
    • Bibliography (Bibliography.jl,...)
    • Packages involved in research projects (J-SPACE,....)
  • Developer Tools
    • File support (XAM,...)
    • Extra resources (workshops, recorded conferences,...)

Describe alternatives you've considered
Top-bar navigation seems optimal in this instance. If, for whichever reason, a top-bar cannot be implemented, we could simply highlight/categorize relevant packages in a new page.

Additional context
Some screenshots of the current SciMLDocs top-bar:

Image

Image

@M-PERSIC M-PERSIC added the high priority Needs to be resolved as soon as possible label Jul 17, 2023
@M-PERSIC M-PERSIC added this to the Minimum Viable Product milestone Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
high priority Needs to be resolved as soon as possible
Projects
None yet
Development

No branches or pull requests

1 participant