Skip to content

Commit

Permalink
docs: restructure and update documentation paths
Browse files Browse the repository at this point in the history
The diff indicates updates to the README.md file with a new path for the diagram image, a link to the drawio file reflecting the new path, and additional inspiration sources.
  • Loading branch information
jjjermiah committed Sep 4, 2024
1 parent fcacd1c commit 4865528
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,17 @@

## Draft Structure:

![alt text](diagrams/handbook_overview.drawio.png)
![alt text](docs/diagrams/handbook_overview.drawio.png)

Edit this diagram using drawio or vscode drawio extension: `./diagrams/handbook_overview.drawio`
Edit this diagram using drawio or vscode drawio extension: `docs/diagrams/handbook_overview.drawio.png`

Insipiration:

- [Koesterlab Handbook](https://koesterlab.github.io/data-science-for-bioinfo/)
- [Candice Morey Lab Handbook](https://ccmorey.github.io/labHandbook/)
- [Baby Lab Handbook](https://mcmaster-baby-lab.github.io/handbook/)
- [Lowe Power Lab Handbook](https://github.com/lowepowerlab/lab_handbook)
- [Vortex Lab Handbook](https://github.com/uw-vortex/VORTEX-handbook)

## Table of Contents
- [Development](#development)
Expand Down
File renamed without changes
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Welcome to the BHK Lab Handbook!

Draft structure:

![alttext](diagrams/handbook_overview.drawio.png)

Insipiration:

- [Koesterlab Handbook](https://koesterlab.github.io/data-science-for-bioinfo/)
Expand Down

0 comments on commit 4865528

Please sign in to comment.