very-good-science / our-handbook

This is a Jupyter-Book template for a research group handbook
https://very-good-science.github.io/our-handbook/
Other
7 stars 37 forks source link

Create consistent `our-handbook` style + instructions for contributors #28

Open NatalieZelenka opened 3 years ago

NatalieZelenka commented 3 years ago
jatonline commented 3 years ago

Some ideas... It would be good to have a unified way of leaving 'notes' or guidance folks filling in the template handbook.

Use cases:

lauren-cadwallader commented 3 years ago

I think it would be useful to have different types of instructions/hints so some are like "you need to do this" (a direct instruction) and others are like "you might be able to find this information from your Research Office" (a hint to make things better/easier).

jatonline commented 3 years ago

Where we have separate instructions for authors editing the handbook in their web browser or on their local machine, we could also suggest the use of tabs to split each set of instructions (see #53)