From e55c76c4df4b6dae03037bd61e3de6a23d588cd9 Mon Sep 17 00:00:00 2001
From: Dristpunk <dristpunk@gmail.com>
Date: Mon, 11 Dec 2023 15:13:09 +0300
Subject: [PATCH] fix: gas comments

---
 .github/workflows/docs.yml | 10 +++++-----
 build-docs.sh              |  7 ++++---
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 424b9759..1dab2031 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -8,7 +8,7 @@ on:
 
 jobs:
   deploy-docs:
-    # Remove the following line if you wish to export your Solidity contracts and interfaces and publish them to NPM
+    # Remove the following line if you wish to deploy the documentation to Vercel
     if: false
     name: Deploy docs
     runs-on: ubuntu-latest
@@ -41,9 +41,9 @@ jobs:
 
       - uses: amondnet/vercel-action@v25
         with:
-          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
-          vercel-org-id: ${{ secrets.ORG_ID}} #Required
-          scope: ${{ secrets.ORG_ID}} #Required
+          vercel-token: ${{ secrets.VERCEL_TOKEN }}
+          vercel-org-id: ${{ secrets.ORG_ID}}
+          scope: ${{ secrets.ORG_ID}}
           vercel-args: ${{ github.ref_name == 'main' && '--prod' || '' }}
-          vercel-project-id: ${{ secrets.PROJECT_ID}} #Required
+          vercel-project-id: ${{ secrets.PROJECT_ID}}
           working-directory: ./docs/book
diff --git a/build-docs.sh b/build-docs.sh
index 14c0eecd..c793e3a4 100644
--- a/build-docs.sh
+++ b/build-docs.sh
@@ -1,9 +1,13 @@
 #!/bin/bash
 
 root_path="src" # this could be src/interfaces
+
 # generate docs in a temporary directory
 temp_folder="technical-docs"
 
+# path to the base folder
+base_folder="docs/src/$root_path"
+
 FOUNDRY_PROFILE=docs forge doc --out "$temp_folder"
 
 # edit generated summary not to have container pages
@@ -51,8 +55,5 @@ replace_text() {
     done
 }
 
-# path to the base folder
-base_folder="docs/src/$root_path"
-
 # calling the function to fix the paths
 replace_text "$base_folder"
\ No newline at end of file