Merge pull request #153 from CoinFabrik/148-add-troubleshooting-guide…

…-to-documentation

Add Troubleshooting Guide

.github/workflows/test-deploy-docs.yml

@@ -12,7 +12,7 @@ jobs:
     name: Test deployment
     runs-on: ubuntu-latest
     outputs:
-      build-success: ${{ steps.build.outputs.success }}
+      status: ${{ job.status }}
     defaults:
       run:
         working-directory: ./docs
@@ -47,10 +47,7 @@ jobs:
 
       - name: Test build website
         id: build
-        run: |
-          if pnpm build; then
-            echo "build-success=true" >> $GITHUB_ENV
-          fi
+        run: pnpm build
 
   comment-on-pr:
     name: Comment on PR
@@ -75,6 +72,6 @@ jobs:
           body: |
             📘 **Documentation Test Summary** 📘
 
-            ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The test build of the documentation has completed successfully. 🚀\n') }}
-            ${{ (needs.test-deploy.outputs.build-success == 'true' && 'The changes will be published upon merge to the main branch') }}
-            ${{ (needs.test-deploy.outputs.build-success != 'true' && 'There was an issue with the test build of the documentation. Please check the logs for more details. 🚨') }}
+            ${{ (needs.test-deploy.outputs.status == 'success' && '✅ The test build of the documentation has completed successfully!' || '') }}
+            ${{ (needs.test-deploy.outputs.status == 'success' && '📝 The changes will be published upon merge to the main branch.' || '') }}
+            ${{ (needs.test-deploy.outputs.status != 'success' && '🚨 There was an issue with the test build of the documentation, please check the logs for more details.' || '') }}

docs/docs/intro.md

@@ -106,3 +106,48 @@ You'll also need to have installed the CLI, as the extension uses the CLI to per
 ### Usage
 
 After you've installed the extension, simply open a project workspace that contains any Soroban (.rs) files. You will see potential issues and warnings via a wiggle underline of the relevant code.
+
+
+## Troubleshooting Guide
+
+### 1. Installation Troubleshooting
+
+**Issue**: Difficulties installing dependencies and Scout.
+
+**Solution**:
+
+- For Dylint:
+
+To install necessary libraries for Dylint, run the following commands:
+  ```bash
+  sudo apt install libssl-dev
+  sudo apt install pkg-config
+  ```
+
+- For C Compiler (gcc). 
+
+To install gcc, which is required for some components, use:
+  ```bash
+  sudo apt install gcc
+  ```
+
+- For error `error[E0658]`. 
+
+When encountering this error `error[E0658]: use of unstable library feature 'stdsimd'`, run cargo clean and ensure you are using this version of rustup:
+```bash
+ cargo clean
+ rustup default nightly-2023-12-16
+ ```
+
+### 2. Crossed Contract Calls
+
+**Issue**: Scout encounters issues when analyzing contracts that perform crossed calls.
+
+**Solution**:
+- When encountering problems with crossed calls, it's beneficial to compile the dependent contract first. Run the following command to build the second contract:
+```bash
+  soroban contract build
+```
+
+
+