From 18c9a59bb3cfee590f33ee5491eca4827786ed2a Mon Sep 17 00:00:00 2001 From: Daniel Thoren Date: Sat, 12 Mar 2022 20:37:12 +0100 Subject: [PATCH] :truck: :sparkles: move documentation --- documentation.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/documentation.md b/documentation.md index e0d45e6..019640c 100644 --- a/documentation.md +++ b/documentation.md @@ -3,15 +3,20 @@ The project planning happens on the _Jira board_ and the project documentation is added to _Confluence pages_. The setting up of Jira & Confluence is outlined in [Project Lifecycle](project_planning.md#project-lifecycle). +### General Tips +* Include conceptual graphical documentation as inline embedded images. +* Save Matplotlib / Seaborn plots as `.svg`. +* Sketches and handwritten illustrations scanned / photographed as `.png`/`.jpg`. +* Scanned / photographed illustrations should be cropped, contrast and alligned. -## Misc Tricks +### Markdown Tips -### Markdown Folding cell +* Use [Google's Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation.
- Click here to see the markdown _code_ for foldable cell 🎆 +Click here to see the markdown _code_ for foldable cell 🎆