dannydannydanny/methodology
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

🚚 ✨ move documentation

Browse source
This commit is contained in:
dannydannydanny 2022-03-12 20:37:12 +01:00 • committed by GitHub
parent d01bdfa17c
commit 18c9a59bb3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
documentation.md
View file

@ -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.
<details>
<summary>
Click here to see the markdown _code_ for foldable cell 🎆
Click here to see the markdown _code_ for foldable cell 🎆
</summary>