search

cheminfo / nmrium

React component to display and process nuclear magnetic resonance (NMR) spectra.
https://docs.nmrium.org
MIT License
55 stars 25 forks source link

Be able to write userguide in the project #276

Open lpatiny opened 4 years ago

lpatiny commented 4 years ago

I would like that we have a question mark that open a dialog with on the left a hierarchical table of contents and on the right the content.

The userguide should be written in markdown and contain some links and images

The documentation could look like:

image

The help should be accessible from a question mark on the top left of the component.

Some ideas about how to do it ?

nes-cgn commented 4 years ago

No idea how to do it, but I think this would be a task for Eva Ziegler (putting the contents). If it is clear how that would be designed she could provide the docu texts, since she will work on the documentation anyway @jliermann : Do you agree?

lpatiny commented 4 years ago

The goal is to do it in 'md' format but it is not that difficult to learn if you have visual studio code installed.

jliermann commented 4 years ago

@nes-cgn: Fine by me!