Guidelines authors

[jchiquet]

Great work, thanks. I have pushed some basic corrections. and left TOD, plus some new additional

• A pass at example template contents for accuracy and to avoid saying things already said in guidelines? Maybe looking at shortcodes in quarto.

• Remove “How to automatically publish the HTML of my contribution to a website?” From the FAQ ?

• say something about the .gitignore files and what should be in it (we should probably update the .gitignore of the templates)

• The figures are sometimes hard to read... see if there is a Quarto mechanism to zoom in (it seems that there is an extension that @fradav knows about)

• The Example papers are not example paper but templates

• We must reference the mock t-SNE papers as example papers

[pneuvial]

Thanks a lot! I've added that one should clone the repo locally before installing the quarto extension.

Some other points:

• Add guidelines for handling dependencies in Julia
• Explain that it is possible to use multiple languages provided that we use the knitr engine.
• Add a TL;DR section with the main points/commands at the beginning of the document
• Should we recommend to use pak instead of remotes for package installation?
• (for R users) recommend using R >= 4.5.1 for a seamless workflow with renv
• document the fact that users may keep their repository private during the writing phase as long as it is made public before submission

[jchiquet]

I am merging this first batch of modification. The following remain (will open another PR/Issue)

• Add guidelines for handling dependencies in Julia
• Explain that it is possible to use multiple languages provided that we use the knitr engine.
• Add a TL;DR section with the main points/commands at the beginning of the document
• Should we recommend to use pak instead of remotes for package installation?
• (for R users) recommend using R >= 4.5.1 for a seamless workflow with renv