Merge pull request #539 from nfdi4plants/arcitect-installation

improve arcitect installation and help
nfdi4plants · Dec 19, 2024 · 8e4a8c6 · 8e4a8c6
2 parents 7351776 + 54b70e3
commit 8e4a8c6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 25 deletions.
diff --git a/src/content/docs/arcitect/index.mdx b/src/content/docs/arcitect/index.mdx
@@ -1,15 +1,18 @@
 ---
 title: ARCitect
 lastUpdated: 2023-11-02
+sidebar:
+    order: 1
 ---
 
-Welcome to the ARCitect Manual.
+The **ARCitect** is a cross-platform app to create and manage your ARCs and synchronize them with the DataHUB.
 
 - Please install the ARCitect following [these instructions](/nfdi4plants.knowledgebase/arcitect/installation)
-- The guide [Start Here](/nfdi4plants.knowledgebase/start-here) introduces the major ARCitect functions
+- The [Start Here](/nfdi4plants.knowledgebase/start-here) guide introduces the major ARCitect functions
 
 :::tip
-After installation, please check the ARCitect's help menu for further documentation and guides.
+After installation, please check the ARCitect's help menu and tooltips for further documentation and guides.
+The help menu can be activated in the `Settings` menu available in the sidebar.
 :::
 
 :::note[For Developers]

diff --git a/src/content/docs/arcitect/installation.mdx b/src/content/docs/arcitect/installation.mdx
@@ -4,6 +4,8 @@ lastUpdated: 2024-10-22
 authors:
   - dominik-brilhaus
   - hannah-dörpholz
+sidebar:
+    order: 2
 ---
 
 import { Steps } from '@astrojs/starlight/components';
@@ -36,11 +38,12 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
 </TabItem>
 <TabItem label="Macos" icon="apple">
 
-
 :::note[Git Installation]
-Please install <a href="https://git-scm.com/downloads" target="_blank">Git</a> before installing the ARCitect.
-    :::tip
-    For macOS we recommend to install via homebrew as described on the site above.
+Please install <a href="https://git-scm.com/downloads" target="_blank">Git</a> and <a href="https://git-lfs.com" target="_blank">Git LFS</a> before installing the ARCitect.
+:::
+
+:::tip
+For macos we recommend to install via homebrew as described on the site above.
 :::
 
 <Steps>
@@ -55,39 +58,38 @@ import MacOSPopupNetwork from "@images/arcitect/macos-popup-network.png"
 
 3. Double-click the installer `ARCitect-x.x.x.dmg` and move the app to your Applications folder.
 
-4. Starting the ARCitect for the first time.
+</Steps>
 
-    :::note[Unidentified developer]
-    When starting the ARCitect for the first time, you are warned about an unidentified developer.
+### Unidentified developer
+When starting the ARCitect for the first time, you are warned about an unidentified developer.
 
-    <img src={MacOSPopup.src} style="width:25%;display: block; margin: 20px" />
+<img src={MacOSPopup.src} style="width:25%;display: block; margin: 20px" />
 
-    Please navigate to the Privacy & Security panel in your System Settings to `Open Anyway`.
+Please navigate to the Privacy & Security panel in your System Settings to `Open Anyway`.
 
-    <img src={MacOSSecurity.src} style="width:50%;display: block; margin: 20px" />
-    :::
+<img src={MacOSSecurity.src} style="width:50%;display: block; margin: 20px" />
 
-    :::note[Incoming network connections]
-    Every time you start the ARCitect, you are asked to accept incoming network connections.
 
-    <img src={MacOSPopupNetwork.src} style="width:25%;display: block; margin: 20px" />
+### Incoming network connections
 
-        :::tip
-        This enables communication with the [DataHUB](/nfdi4plants.knowledgebase/datahub).
-
-</Steps>
+Every time you start the ARCitect, you are asked to accept incoming network connections.
+
+<img src={MacOSPopupNetwork.src} style="width:25%;display: block; margin: 20px" />
 
+This enables communication with the [DataHUB](/nfdi4plants.knowledgebase/datahub).
 
 
 </TabItem>
 
 <TabItem label="Linux" icon='linux'>
 
 :::note[Git Installation]
-Please install <a href="https://git-scm.com/downloads" target="_blank">Git</a> and <a href="https://git-lfs.github.com/" target="_blank">Git LFS</a> before installing the ARCitect.
-    :::tip
-    For Linux we recommend to install via homebrew as described on the site above.
-    :::
+Please install <a href="https://git-scm.com/downloads" target="_blank">Git</a> and <a href="https://git-lfs.com" target="_blank">Git LFS</a> before installing the ARCitect.
+:::
+
+:::tip
+For Linux we recommend to install via homebrew as described on the site above.
+:::
 
 <Steps>