Editing the wiki - theunissenlab/lab-documentation GitHub Wiki

Guidelines

1 Repeat information as little as possible

2 Make information searchable

3 Instructions should be simple lists, with links or dropdowns for more detail

Try to organize things so that they can be easily read by someone who just needs to be reminded of steps, but also by someone who needs detailed instructions. Really detailed documentation should be put on another page and linked to.

4 Note dates when relevant

5 Create separate troubleshooting sections

6 Information should be easy to find.

The sidebar should be like an index for people who know generally what they are looking for, while intro pages or "how to..." pages should be the starting point for someone new in the lab or someone who wants to do a procedure they've never done before.

7 Table of contents help on long pages

Tips

Adding a File

You can either upload files directly to the main github repository, or clone it, commit the files, and push. For diagrams that have a editable and non-editable version (e.g. illustrator files -> png, latex files -> pdf), it is helpful to upload both so that they can be modified in the future. A suggested folder structure could be

wiki_images/
  behavior/                     <- general page category
    raw/                        <- folder for editable raw files
      room125_diagram.ai
    final/                      <- folder for embedded final files
      room125_diagram.png

Embedding an image

First, upload the image to an appropriate folder in the main repository from "Adding a file". Then embed it with the link here:

![Data Pipeline Diagram](https://github.com/theunissenlab/lab-documentation/blob/master/pipeline-diagram.png)

You can specify a specific size for the image with the <img> tag instead.

<img src="URL" data-canonical-src="URL" width="536" height="315" />

Creating a dropdown

Use this one sparingly - this keeps instructions tidy but harder to search with Ctrl+F. Commonly used in the sidebar.

Make sure you have empty line after the <summary> line.

   <details>
   <summary>Office Stuff (Reserving rooms, reimbursements, ...)</summary>

   * [[Calendars | Calendars]]
   * [[Reimbursements and BearBuy|Reimbursements and BearBuy]]
   * [[Reserving Conference Rooms]]
   </details>