docs: Fixed grammar mitakes, added more info, and added links

memorycircuits · Jul 18, 2024 · f161222 · f161222
1 parent 27a4ec4
commit f161222
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 9 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+    "languageToolLinter.languageTool.ignoredWordsInWorkspace": [
+        "syndb"
+    ]
+}
diff --git a/docs/dataset/2-upload.md b/docs/dataset/2-upload.md
@@ -1,11 +1,9 @@
-{% assign overview_link = "[overview article](0-overview.md)" %}
-
 # Upload
 
 !!! note "Prerequisites"
-    This article requires that you understand how data is stored on SynDB, we recommend reading through the {{ overview_link }}.
+    This article requires that you understand how data is stored on SynDB, we recommend reading through the [overview article](0-overview.md) if you are uncertain.
 
-Uploading to SynDB is multistep process, and requires understanding of the SynDB dataset model.
+Uploading to SynDB is a multistep process, and requires understanding of the SynDB dataset model.
 
 ## The process
 
@@ -48,7 +46,7 @@ The GUI will automatically assign UUIDs to each SynDB table unit. The relations
 TODO
 
 #### 2. Selecting or creating the SynDB dataset metadata
-As mentioned, in the {{ overview_link }}, every dataset has a metadata defined by the data owner during the upload. You can either select an existing dataset or create a new one.
+As mentioned, in the "[overview article](0-overview.md)", every dataset has a metadata defined by the data owner during the upload. You can either select an existing dataset or create a new one.
 
 #### 3. Confirm and upload
 Before the upload starts you will be prompted to confirm the dataset and the data you are uploading. Once you confirm, the upload will start. Should be relatively quick.

diff --git a/docs/get_started/0-home.md b/docs/get_started/0-home.md
@@ -1,9 +1,11 @@
 # Welcome to SynDB
 
-SynDB is the platform finding and sharing synapse metrics derived from high resolution microscopy essays.
+SynDB is the platform for finding, and sharing synapse metrics derived from high resolution microscopy assays.
 
 Head over to the [installation guide](2-install.md) to get started; [upload guide](../dataset/2-upload.md) to share your data; [search guide](../dataset/1-search.md) to find data; [API documentation](https://api.syndb.org/docs) for advanced users.
 
-:simple-youtube:
+## :simple-youtube:{ .youtube } Tutorials on YouTube
+Explore the tutorials on how to use SynDB on our [YouTube playlist]({{ youtube.playlist }}).
 
-:simple-discord: 
+## :simple-discord:{ .discord } Raise issues and discussions on Discord
+Participate in the community on our [Discord server]({{ discord.url }}).
diff --git a/docs/get_started/2-install.md b/docs/get_started/2-install.md
@@ -14,6 +14,12 @@ pipx install syndb-cli[gui]
 pipx install syndb-cli
 ```
 
+### Upgrade
+To upgrade the SynDB CLI along with the GUI (if installed), run the following command:
+```bash
+pipx upgrade syndb-cli
+```
+
 ## Advanced
 SynDB provides access to its REST API for advanced users to access the data directly. The API can be accessed through the [OpenAPI documentation]({{ api.url }}). For a more tailored approach, you may interact with the API through the `syndb-data` Python package:
 

diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -0,0 +1,7 @@
+.youtube {
+    color: #EE0F0F;
+}
+
+.discord {
+    color: #7289DA;
+}
diff --git a/includes/macros.yaml b/includes/macros.yaml
@@ -12,3 +12,6 @@ software:
 discord:
   url: https://discord.gg/tmF5WTbFVY
   hyperlink: '[Discord](https://discord.gg/tmF5WTbFVY "Invite link to the SynDB Discord server")'
+
+youtube:
+  playlist: https://www.youtube.com/playlist?list=PL48RF5OdF7Z7sBWDLRO2gd1YCt8QhGDJy
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -28,7 +28,7 @@ theme:
         name: Switch to light mode
 
 extra_css:
-  - assets/custom.css
+  - stylesheets/extra.css
 
 watch:
   - includes