Merge pull request #292 from rsksmart/testDevportalAutoImp

feat/adding omiting comment section
rsksmart · Dec 19, 2024 · dd49d06 · dd49d06
2 parents 685be6d + d1b5b6c
commit dd49d06
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 19 deletions.
diff --git a/.github/workflows/devportal-update.yml b/.github/workflows/devportal-update.yml
@@ -38,14 +38,15 @@ jobs:
           # Remove the unwanted first lines from README.md
           TEMP_FILE="temp_README.md"
           tail -n +1 README.md > ${TEMP_FILE}
-          
+          # Remove the unwanted lines between START and END comments
+          awk '/<!--START/,/<!--END-->/{next} {print}' README.md > ${TEMP_FILE}
           # Process main README.md
           TRANSFORMED_FILE="transformed/README.md"
           echo "---" > ${TRANSFORMED_FILE}
           echo "sidebar_label: Overview" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 100" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay - Overview" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Overview.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Overview." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integrate, integration guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -67,7 +68,7 @@ jobs:
           echo "sidebar_label: Integrations" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 200" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Integration" >> ${TRANSFORMED_FILE}
-          echo "description: 'Integrating RIF Relay in a dApp.'" >> ${TRANSFORMED_FILE}
+          echo "description: Integrating RIF Relay in a dApp." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integration guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -85,7 +86,7 @@ jobs:
           echo "sidebar_label: Setup" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 300" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Installation Requirements" >> ${TRANSFORMED_FILE}
-          echo "description: 'Requirements for installing RIF Relay.'" >> ${TRANSFORMED_FILE}
+          echo "description: Requirements for installing RIF Relay." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -103,7 +104,7 @@ jobs:
           echo "sidebar_label: RIF Relay Sample dApp" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 400" >> ${TRANSFORMED_FILE}
           echo "title: How to use the RIF Relay Sample dApp SDK" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Sample dApp SDK Starter kit.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Sample dApp SDK Starter kit." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integration guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -121,7 +122,7 @@ jobs:
           echo "sidebar_label: RIF Relay Deployment" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 500" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Deployment" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay deployment process.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay deployment process." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integration guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -139,7 +140,7 @@ jobs:
           echo "sidebar_label: Develop" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 600" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Develop" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay deployment process.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay deployment process." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -157,7 +158,7 @@ jobs:
           echo "sidebar_label: Contracts" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 700" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay - Contracts" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Contracts.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Contracts." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -175,7 +176,7 @@ jobs:
           echo "sidebar_label: Smart Wallets" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 800" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Smart Wallets" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Smart Wallets.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Smart Wallets." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, user, guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -193,7 +194,7 @@ jobs:
           echo "sidebar_label: Versions" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 900" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay Versions" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Versions.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Versions." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, rif relay, integration guide]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -211,7 +212,7 @@ jobs:
           echo "sidebar_label: Gas Costs" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 950" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay - Gas Costs" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Gas Costs.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Gas Costs." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}
@@ -229,7 +230,7 @@ jobs:
           echo "sidebar_label: Architecture" >> ${TRANSFORMED_FILE}
           echo "sidebar_position: 980" >> ${TRANSFORMED_FILE}
           echo "title: RIF Relay - Architecture" >> ${TRANSFORMED_FILE}
-          echo "description: 'RIF Relay Architeture.'" >> ${TRANSFORMED_FILE}
+          echo "description: RIF Relay Architeture." >> ${TRANSFORMED_FILE}
           echo "tags: [rif, envelope, relay, integrate]" >> ${TRANSFORMED_FILE}
           echo "---" >> ${TRANSFORMED_FILE}
           echo "" >> ${TRANSFORMED_FILE}

diff --git a/README.md b/README.md
@@ -42,4 +42,4 @@ Each module has instructions for development and usage.
 * Please refer to the Rootstock Contribution Guidelines for more information on how to contribute to this project.
 
 ## License:
-MIT License - Copyright (c) 2023 Rootstock
+MIT License - Copyright (c) 2023 Rootstock
diff --git a/docs/installation-requirements.md b/docs/installation-requirements.md
@@ -33,6 +33,4 @@ For a detailed step-by-step guide on getting started with RIF Relay, refer to th
 
 ### Using Docker
 
-- RIF Relay components can be deployed using Docker or locally using [Hardhat](#hardhat). A guide for the [RIF Relay Server](https://github.com/rsksmart/rif-relay-server#execute-as-a-docker-container) can be found in the repository.
-
-test
+- RIF Relay components can be deployed using Docker or locally using [Hardhat](#hardhat). A guide for the [RIF Relay Server](https://github.com/rsksmart/rif-relay-server#execute-as-a-docker-container) can be found in the repository.
diff --git a/docs/integrate.md b/docs/integrate.md
@@ -289,6 +289,4 @@ To implement and use your own replenish strategy:
 1. In the folder `src` from the RIF Relay Server project, open `ReplenishFunction.ts` with a text editor.
 2. On the function `replenishStrategy` write your new replenish strategy.
 3. Re build the project `npm run build`
-4. Change the config JSON file to set `customReplenish` on true.
-
-t
+4. Change the config JSON file to set `customReplenish` on true.