Skip to content

Commit

Permalink
Merge pull request #552 from SabrinaZander/Start-Guide-overhaul
Browse files Browse the repository at this point in the history
Start guide changes
  • Loading branch information
Brilator authored Feb 11, 2025
2 parents 89fb237 + ef64cbe commit d24d9b8
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 14 deletions.
15 changes: 8 additions & 7 deletions src/content/docs/start-here/assays.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,21 +161,22 @@ Instead of adding each individual building block to the table, we can use a gene
3. In the `New Table!` widget, click on the `Add Template` button next to `Start from an existing template!`.
4. From the `Select community` dropdown, select "Training".
5. Click the name of the template `Training - Sugar extraction` and `select`.
6. Select the `Use Template name` checkbox to rename the sheet.
6. Select `Import Type` with Units.
7. Select the `Use Template name` checkbox to rename the sheet.

<ViolaSays>
This shows me that the template has an **Input**, **Output** as well as two **Parameter** columns: "Vortex Mixer" and "Temperature"
</ViolaSays>

6. Click `Add template` to add the columns to your table.
8. Scroll down and click `Add template` to add the columns to your table.


Input [Sample Name] | Parameter [Vortex Mixer] | Parameter [Temperature] | Output [Sample Name]
--- | --- | --- | ---
| | |

7. At the bottom of the table, type `5` in the text field and click `+` to add 5 rows to your table for a total of 6 since one was added automatically.
8. Transfer the sample names of your study's `Output [Sample Name]` to the `Input [Sample Name]` column.
9. At the bottom of the table, type `5` in the text field and click `+` to add 5 rows to your table for a total of 6 since one was added automatically.
10. Transfer the sample names of your study's `Output [Sample Name]` to the `Input [Sample Name]` column.

Input [Sample Name] | Parameter [Vortex Mixer] | Parameter [Temperature] | Output [Sample Name]
--- | --- | --- | ---
Expand All @@ -186,7 +187,7 @@ Instead of adding each individual building block to the table, we can use a gene
RT2_leaf
RT3_leaf

9. Add information of the `sugar_extraction_protocol.md` into the table, e.g.
11. Add information of the `sugar_extraction_protocol.md` into the table, e.g.


Input [Sample Name] | Parameter [Vortex Mixer] | Parameter [Temperature] | Output [Sample Name]
Expand All @@ -198,7 +199,7 @@ Instead of adding each individual building block to the table, we can use a gene
RT2_leaf | 3 seconds | 95 degree celsius |
RT3_leaf | 3 seconds | 95 degree celsius |

10. Fill the `Output [Sample Name]` column:
12. Fill the `Output [Sample Name]` column:
- Select the six cells from `Input`, and copy the sample names (right-click -> Copy)
- Select the cell below `Output [Sample Name]` and paste the sample names (right-click -> Paste all)
- Click Right-click -> Update on a cell below `Output [Sample Name]` to change the sample names
Expand All @@ -214,7 +215,7 @@ Instead of adding each individual building block to the table, we can use a gene
RT2_leaf | 3 seconds | 95 degree celsius | RT2_sugar-ext
RT3_leaf | 3 seconds | 95 degree celsius | RT3_sugar-ext

11. Click the `Save` button.
13. Click the `Save` button.
</Steps>
</Card>

Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/start-here/create-arc-scaffold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ import ARCitectInstallation from '../arcitect/installation.mdx'

</ViolaSays>

:::tip
- Use a short acronym
- Avoid spaces and special characters in your ARC's name
- Avoid administrative metadata (name, data, etc.)
- Use a combination of keywords maybe grant number
:::

4. ARCitect creates the base ARC folder on your computer and opens it right away.

<FileTree>
Expand All @@ -84,12 +91,5 @@ By default, your ARC's name will be used:
1. For the **ARC folder** on your computer.
2. As the **investigation identifier**.

:::tip
- Use a short acronym
- Avoid spaces and special characters in your ARC's name
- Avoid administrative metadata (name, data, etc.)
- Use a combination of keywords maybe grant number
:::

</Card>

5 changes: 5 additions & 0 deletions src/content/docs/start-here/share.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ In the History menu you can inspect your ARC history with all commit messages.
</Steps>
</Card>

:::note
If you edit your ARC in a different location (e.g. the DataHUB or another computer) be sure to synchronize your local ARC using the `Pull` button.
:::


## Explore your ARC in the PLANTDataHUB

<Card icon="gitlab" title="PLANTDataHUB">
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/start-here/study.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ You can use the protocol subdirectory to store free-text protocols that describe


3. Select the file `growth_protocol.md` from the demo data and click `Open`.

:::note
In this example Viola has prepared a Markdown file (.md) as a protocol.
Markdown Guide: https://www.markdowntutorial.com/


4. The file is added to your ARC.

<FileTree>
Expand Down

0 comments on commit d24d9b8

Please sign in to comment.