Merge pull request #358 from crytic/medusa-docs

Add medusa docs

Author: montyly

.github/workflows/deploy.yml

@@ -22,6 +22,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
       - name: Install mdbook
         run: |
           cargo install --git https://github.com/montyly/mdBook.git mdbook || true

.github/workflows/lint_format.yml

@@ -13,6 +13,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
@@ -23,6 +25,13 @@ jobs:
         run: |
           npm ci
 
+      - name: Remove Medusa uncessary files
+        run: |
+          rm -rf program-analysis/medusa/chain
+          rm -rf program-analysis/medusa/compilation
+          rm -rf program-analysis/medusa/fuzzing
+          rm program-analysis/medusa/docs/theme/highlight.js
+
       - name: Run lint
         run: |
           npm run lint:format

.github/workflows/lint_links.yml

@@ -24,3 +24,4 @@ jobs:
         with:
           use-quiet-mode: "yes"
           check-modified-files-only: ${{ (github.event_name == 'pull_request' && 'yes') || 'no' }}
+          submodules: true

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "program-analysis/medusa"]
+	path = program-analysis/medusa
+	url = https://github.com/crytic/medusa.git

SUMMARY.md

@@ -106,6 +106,15 @@
       - [Exercise 6](./program-analysis/echidna/exercises/Exercise-6.md)
       - [Exercise 7](./program-analysis/echidna/exercises/Exercise-7.md)
       - [Exercise 8](./program-analysis/echidna/exercises/Exercise-8.md)
+  - [Medusa](./program-analysis/medusa/docs/src/README.md) - [Getting Started](./program-analysis/medusa/docs/src/getting_started/installation.md)
+    - [Project Configuration](./program-analysis/medusa/docs/src/project_configuration/overview.md)
+      the vast number of configuration options that can be set up based on your project needs.
+    - [Command Line Interface](./program-analysis/medusa/docs/src/cli/overview.md)
+    - [Writing Tests](./program-analysis/medusa/docs/src/testing/overview.md)
+    - [API (WIP)](./program-analysis/medusa/docs/src/api/api_overview.md)
+    - [Cheatcodes](./program-analysis/medusa/docs/src/cheatcodes/cheatcodes_overview.md)
+    - [Console Logging](./program-analysis/medusa/docs/src/console_logging.md)
+    - [FAQ](./program-analysis/medusa/docs/src/faq.md)
   - [Manticore](./program-analysis/manticore/README.md)
     - [Introduction to symbolic execution](./program-analysis/manticore/symbolic-execution-introduction.md):
     - [Running under Manticore](./program-analysis/manticore/running-under-manticore.md)