add complementary writing guidelines #75
Labels
alpha-stage
To do before upgrade life cycle to alpha
documentation
Improvements or additions to documentation
early-task
Part of the Early Task Roadmap
priority
to-all-tasks
To apply in all repos after solved in early-task
upcoming-training
To prioritize
In:
tutorials/CONTRIBUTING.md
Line 132 in ad7dd94
For Workbench novice users:
sandpaper::build_lesson()
.Add in the Developers:
sandpaper::build_lesson()
. This will open an HTML tab in your browser to review. This HTML format is how the website is going to look online (without the epiverse-trace{varnish}
epiverse theme or tracelac theme).sandpaper::create_episode_rmd(title, add)
orepisodes/template.Rmd
install.packages()
orpak::pak()
inside an episode file. We rely on{renv}
via{sandpaper}
to keep a stable package version to render the website and automatic workflows to notify of any unexpected changes.[author et al., year](link)
since this format does not supports bib files.[^1]
to-keep
read new features we want to keep in this repo.git rebase
. This:{lintr}
addin to "Lint current file" from Rstudio or other editors.file.path()
for developer andhere()
for learner view.withr::local_options()
instead ofoptions()
.png
format, which is more appropriate to be displayed in modern web browsers. Any original figure in any other format, should be kept in that original format.config.yaml
fileAdd in the Maintainers:
Update the renv.lock and activate.R files locally with the workbench
If a
renv
or any automatic update generates an unexpected change in any R outputs, then we should use that same PR to make the corresponding correction.Add to general installation
How to refer to local files within episodes? Here are examples of how we redirect to:
[word](../learners/reference.md#word-tag)
[word](../episodes/name-of-episode.md)
or[word](name-of-episode.md)
(?)[data_cases.csv](data/data_cases.csv)
this facilitates a direct download, check.The text was updated successfully, but these errors were encountered: