search

BaRatin-tools / BaRatinAGE

BaRatin Advanced Graphical Environment
https://baratin-tools.github.io/en/
GNU General Public License v3.0
4 stars 0 forks source link

Review documentation strategy #34

Closed benRenard closed 6 months ago

benRenard commented 1 year ago

Currently we have html help files, linking to word-created pdf files with equations/figures. In BaM, we started documenting each model with LateX-produced model sheets. In RBaM, vignettes are in R-markdown.

Should we change this and try to be more consistent?

I'm personally keen to get rid of all word-like documents, and instead move to either LateX or markdown.

In particular, could we do everything with markdown? An advantage is that we could render the markdown files as either html or pdf.

Also, should we go 100% online or should all these files be distributed along with the executable?

benRenard commented 1 year ago

Related request: Edition d'un guide utilisateur en compilant les aides html et fiches

Si un moyen simple existait pour concaténer ces documents, on aurait 2 manuels FR et ENG à citer comme référence. Ce serait chouette car ce sont en fait les meilleurs descriptions de BaRatin et BaRatinAGE que nous ayons à citer...

benRenard commented 6 months ago

I'm closing the ticket since https://baratin-tools.github.io implements the 100%-online, markdown-based solution. I'm making a new ticket for the compilation of a pdf version of the online help