loculus-project / loculus

An open-source software package to power microbial genomic databases
https://loculus.org
GNU Affero General Public License v3.0
37 stars 2 forks source link

Arbitrary modals from markdown files #2237

Open theosanderson opened 4 months ago

theosanderson commented 4 months ago

There are various places ("How to search help", "Data use terms", "How to do mutation search"), where ideally we would probably open in a modal displaying markdown rather than sending people to a different page. (Maybe with a button to open as a full page, as we already do for the "preview modal"). We could fairly easily make a component that would do this for us.

chaoran-chen commented 4 months ago

The would however mean that we commit to developing the documentation pages ourselves, right? Instead of moving them to starlight?

theosanderson commented 4 months ago

Well we'd need a copy of the markdown somewhere on the website. In the case of e.g. the data use terms I don't think anyone was advocating for Starlight, and the "How to use mutation search" is already (going to be) part of the website by virtue of being a modal. So in 2/3 of the use cases mentioned so far it isn't relevant, but yes there is some connection