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

[FEATURE] Using Markdown for the online doc #91

Open
lmichel opened this issue Dec 18, 2021 · 4 comments
Open

[FEATURE] Using Markdown for the online doc #91

lmichel opened this issue Dec 18, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@lmichel
Copy link
Owner

lmichel commented Dec 18, 2021

Is your feature request related to a problem? Please describe.

Both issues #90 and #75 mention a doc folder for documentation resources.

These doc files could be in HTML, but HTML is painful to update (never updated thus)

A convenient solution would be to use Markdown for these resources. This allows good rendering with an easy edition.

There are many JS tools able to process MD resources.

We have to select one and use it everywhere we have to display static online documentation.

@lmichel lmichel added the enhancement New feature or request label Dec 18, 2021
@galyfray galyfray added the documentation Improvements or additions to documentation label Jan 3, 2022
@galyfray
Copy link
Collaborator

galyfray commented Jan 6, 2022

tooltips and other things could be handy to put in those docs. we could use the java's file formats for location making it easier to change or correct any message as a lot of message are hidden somewhere in the code and are kind of a pain to find when information is missing or there is a typo in it ...

@lmichel
Copy link
Owner Author

lmichel commented Jan 6, 2022

Great, but according to the time left, I suggest to keep focused on the main features

@lmichel
Copy link
Owner Author

lmichel commented Jan 6, 2022

We have to separate the label management and the online docs:

  • Label: one JSON file like {LABEL: text...} loaded at startup and accessible as a global variable for the whole application. The can be made in a progressive way, label per label.
  • Doc: the doc text, e.g. credit, are longer and more structured the simple labels. they must be store in individuel MD pages. The HTML conversion could be made by a specific JS module.

@lmichel
Copy link
Owner Author

lmichel commented Jan 6, 2022

This issue is related to #90 #110

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants