From 7f569471f6bbd7f6630fe2fe00015849c27244c4 Mon Sep 17 00:00:00 2001 From: bl0up Date: Fri, 2 Aug 2024 11:02:10 +0200 Subject: [PATCH] fix: broken links --- .../managed-cloud-deployment/1_quickstart.md | 24 +++++++++---------- .../{legcay => legacy}/_category_.json | 0 .../{legcay => legacy}/auth-api-requests.md | 0 .../completing-setup-and-deploying.md | 2 +- .../download/_category_.json | 0 .../download/download-airgap.md | 6 ++--- .../legacy/download/download-online.md | 10 ++++++++ .../download/download-portal.md | 4 ++-- .../install-airgap/_category_.json | 0 .../install-airgap/install-airgap.md | 4 ++-- .../install-airgap/install-kots.md | 0 .../install-airgap/install-kotsadm.md | 2 +- .../install-airgap/installer-pull-images.md | 2 +- .../install-online/_category_.json | 0 .../install-online/install-kots.md | 0 .../install-online/install-kotsadm.md | 0 .../install-online/install-online.md | 0 .../overallResourceAllocation.md | 0 .../{legcay => legacy}/requirements.md | 0 .../legcay/download/download-online.md | 10 -------- .../0_smart_contracts.md | 14 ++++++----- ...lates.md => 1_smart_contract_templates.md} | 0 .../7_integrated-development-environment.md | 2 +- 23 files changed, 41 insertions(+), 39 deletions(-) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/_category_.json (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/auth-api-requests.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/completing-setup-and-deploying.md (97%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/download/_category_.json (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/download/download-airgap.md (91%) create mode 100644 docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-online.md rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/download/download-portal.md (92%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-airgap/_category_.json (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-airgap/install-airgap.md (94%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-airgap/install-kots.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-airgap/install-kotsadm.md (97%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-airgap/installer-pull-images.md (92%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-online/_category_.json (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-online/install-kots.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-online/install-kotsadm.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/install-online/install-online.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/overallResourceAllocation.md (100%) rename docs/launch-platform/self-hosted/installing-on-an-existing-cluster/{legcay => legacy}/requirements.md (100%) delete mode 100644 docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-online.md rename docs/using-platform/6_add_smart_contract_sets/{1_ smart_contract_templates.md => 1_smart_contract_templates.md} (100%) diff --git a/docs/launch-platform/managed-cloud-deployment/1_quickstart.md b/docs/launch-platform/managed-cloud-deployment/1_quickstart.md index 7d9096f8..a41ad983 100644 --- a/docs/launch-platform/managed-cloud-deployment/1_quickstart.md +++ b/docs/launch-platform/managed-cloud-deployment/1_quickstart.md @@ -6,9 +6,9 @@ sidebar_position: 3 # Getting Started - Hello World -##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain. +##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain -In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_create-smart-contract-set.md) and [create an integration](../../using-platform/9_integration-studio.md). +In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_add_smart_contract_sets/0_smart_contracts.md) and [create an integration](../../using-platform/9_integration-studio.md). Below is both a video and written guide for you to build along to: @@ -152,9 +152,9 @@ In the IDE, you need to locate and rename the `Example.sol` file that comes incl ![Rename Contract](../../../static/img/quickstart/renamecontract.png) -1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand. -2. Find the `Example.sol` file in the list -3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld +1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand. +2. Find the `Example.sol` file in the list +3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld Now you can replace the code that is in the `HelloWorld.sol` file. @@ -330,7 +330,7 @@ This is done by clicking the name of the private key. There select the `Details` ![Key Created](../../../static/img/quickstart/privatekeycreated.png) ![Alt text](../../../static/img/quickstart/copyprivatekey.png) -With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey = ` inside the ' ''. The private key should begin with `0x`. +With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey =` inside the ' ''. The private key should begin with `0x`. ![Paste Private Key](../../../static/img/quickstart/pasteprivatekey.png) @@ -346,10 +346,10 @@ SettleMint uses Hardhat scripts to deploy smart contracts. To deploy the Hello W ![Deploy Changes](../../../static/img/quickstart/deploychanges.png) -1. Go to the `deploy` folder in the file explorer on the left -2. Open the `00_deploy_example.ts` file -3. Delete the code that is currently in this file -4. Copy and paste the code below: +1. Go to the `deploy` folder in the file explorer on the left +2. Open the `00_deploy_example.ts` file +3. Delete the code that is currently in this file +4. Copy and paste the code below: ```typescript import { DeployFunction } from 'hardhat-deploy/types'; @@ -469,10 +469,10 @@ You can now start interacting with the Hello World contract via a front-end page Your URL will look something similar to this: -Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5` +Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5` After: `https://helloworld-9ece.gke-europe.settlemint.com/helloworld` -In your browser you will see two options `Read-only ` and `Write`functions: +In your browser you will see two options `Read-only` and `Write`functions: - `Read-only`: These functions can only read the data from the smart contract diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/_category_.json b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/_category_.json similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/_category_.json rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/_category_.json diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/auth-api-requests.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/auth-api-requests.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/auth-api-requests.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/auth-api-requests.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/completing-setup-and-deploying.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/completing-setup-and-deploying.md similarity index 97% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/completing-setup-and-deploying.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/completing-setup-and-deploying.md index 567ce4b5..d9efa915 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/completing-setup-and-deploying.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/completing-setup-and-deploying.md @@ -27,7 +27,7 @@ You can access the Admin Console to complete the SettleMint Platform setup, run ![CleanShot 2022-10-01 at 13.01.15@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.152x.png) -- Upload the license file [downloaded from Step 1](../download/download-portal.md) +- Upload the license file [downloaded from Step 1](./download/download-portal.md) ![CleanShot 2022-10-01 at 13.01.29@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.292x.png) diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/_category_.json b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/_category_.json similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/_category_.json rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/_category_.json diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-airgap.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-airgap.md similarity index 91% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-airgap.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-airgap.md index d31f5d25..9a448978 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-airgap.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-airgap.md @@ -16,7 +16,7 @@ From the SettleMint Download Portal, download the following files - Full Bundle or Small Bundle : If you choose the small bundle, set up separate pipeline to push images to your repository. See [below](#understanding-the-structure) for a more detailed explanation. -Continue with [Step 2](../installing-on-an-existing-cluster/install-airgap/install-airgap.md) +Continue with [Step 2](../install-airgap/install-airgap.md) ## Understanding the Structure @@ -60,5 +60,5 @@ Please note that with this option, upgrading to a another version of the SettleM - You may also need to get newer versions of the framework software, but our license page will indicate if so. Once you have downloaded all the files from the link shared with you, you can check that your setup meets the minimum -[requirements](../installing-on-an-existing-cluster/requirements.md) before continuing with the -[installation](../installing-on-an-existing-cluster/install-airgap/install-airgap.md). +[requirements](../requirements.md) before continuing with the +[installation](../install-airgap/install-airgap.md). diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-online.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-online.md new file mode 100644 index 00000000..5d5c67ee --- /dev/null +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-online.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 2 +--- + +# Online Installation + +To proceed with the online installation, you only need to download the license file from the download portal. + +Check that your setup meets the minimum [requirements](../requirements.md) +before proceeding with the [installation](../install-online/install-online.md). diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-portal.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-portal.md similarity index 92% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-portal.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-portal.md index 6f92c4e3..a670af15 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-portal.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/download/download-portal.md @@ -30,8 +30,8 @@ There are 3 options to set up the install. Depending on your license, you can ch - License file - Installers - - [KOTS CLI](../installing-on-an-existing-cluster/install-airgap/install-kots.md) - - [KOTS admin console](../installing-on-an-existing-cluster/install-airgap/install-kotsadm.md) + - [KOTS CLI](../install-airgap/install-kots.md) + - [KOTS admin console](../install-airgap/install-kotsadm.md) - SettleMint Platform, comprising of - Deployer image and scripts - All the component images diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/_category_.json b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/_category_.json similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/_category_.json rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/_category_.json diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-airgap.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-airgap.md similarity index 94% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-airgap.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-airgap.md index 5de51757..45b3b2ef 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-airgap.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-airgap.md @@ -1,7 +1,7 @@ # Install the SettleMint Platform in an Airgap Environment When installing the SettleMint Platform on a cluster without internet access, you will need to ensure that you have -followed the steps discribed in the [download section](../../download/download-airgap.md) to download the required license and installation files. +followed the steps discribed in the [download section](../download/download-airgap.md) to download the required license and installation files. Airgapped install is only available for licenses that have the airgapped feature enabled. @@ -33,7 +33,7 @@ details on Open Shift command line linkages. 2. **Install the [Admin Console](./ 3. **Install the SettleMint Platform application via the Admin Console** - As explained in the [download section](../../download/download-airgap.md), + As explained in the [download section](../download/download-airgap.md), there are 2 ways to proceed with your airgapped installations: Full or Small Bundles. In the case of **Small** Bundle, there is an additional step to run the script to push the images to your local registry. You must run this step **prior** to running the `kots install` command below. diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-kots.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-kots.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-kots.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-kots.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-kotsadm.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-kotsadm.md similarity index 97% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-kotsadm.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-kotsadm.md index 97747d00..7dfe57f9 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/install-kotsadm.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/install-kotsadm.md @@ -11,7 +11,7 @@ kotsadm package. ## Install the Admin Console -1. Download the admin console binary bundle, `kotsadm.tar.gz` ([Downloads](../../download/download-airgap.md)) +1. Download the admin console binary bundle, `kotsadm.tar.gz` ([Downloads](../download/download-airgap.md)) - latest kotsadm release notes can be found [here](https://docs.replicated.com/release-notes/rn-app-manager) diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/installer-pull-images.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/installer-pull-images.md similarity index 92% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/installer-pull-images.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/installer-pull-images.md index c74be1b7..257b6e05 100644 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-airgap/installer-pull-images.md +++ b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-airgap/installer-pull-images.md @@ -8,7 +8,7 @@ Follow these steps from the machine that is connected to your airgapped cluster. 2. Ensure your image registry is setup. See the [Image Registry Section](./install-airgap.md). -3. Run the provided script mentioned in the [download section](../../download/download-airgap.md) to pull the images +3. Run the provided script mentioned in the [download section](../download/download-airgap.md) to pull the images from our repository and push them on your registry. ```bash diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/_category_.json b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/_category_.json similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/_category_.json rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/_category_.json diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-kots.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-kots.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-kots.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-kots.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-kotsadm.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-kotsadm.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-kotsadm.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-kotsadm.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-online.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-online.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/install-online/install-online.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/install-online/install-online.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/overallResourceAllocation.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/overallResourceAllocation.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/overallResourceAllocation.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/overallResourceAllocation.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/requirements.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/requirements.md similarity index 100% rename from docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/requirements.md rename to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legacy/requirements.md diff --git a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-online.md b/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-online.md deleted file mode 100644 index adce65f8..00000000 --- a/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-online.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Online Installation - -To proceed with the online installation, you only need to download the license file from the download portal. - -Check that your setup meets the minimum [requirements](../installing-on-an-existing-cluster/requirements.md) -before proceeding with the [installation](../installing-on-an-existing-cluster/install-online/install-online.md). diff --git a/docs/using-platform/6_add_smart_contract_sets/0_smart_contracts.md b/docs/using-platform/6_add_smart_contract_sets/0_smart_contracts.md index ce3df192..6d58525b 100644 --- a/docs/using-platform/6_add_smart_contract_sets/0_smart_contracts.md +++ b/docs/using-platform/6_add_smart_contract_sets/0_smart_contracts.md @@ -3,14 +3,14 @@ title: Overview description: Overview sidebar_position: 0 --- + # Deploying Smart Contracts ## Introduction -To make developing smart contracts easier, we offer an open-source [template library](/btp-docs/docs/using-platform/6_add_smart_contract_sets/1_smart_contract_templates.md) and an Integrated Development Environment (IDE). The template library includes pre-built smart contracts that you can customize to meet your specific needs. - -If you need a fundamental explanation of what smart contracts are and how they work, we recommend contacting our team to join our Learn World Blockchain course. Our experts will guide you through the basics, ensuring you have a solid foundation before diving into development. For a practical guide, please visit [deploying a contract](/btp-docs/docs/using-platform/6_add_smart_contract_sets/deploying_a_contract.md). +To make developing smart contracts easier, we offer an open-source [template library](./1_smart_contract_templates.md) and an Integrated Development Environment (IDE). The template library includes pre-built smart contracts that you can customize to meet your specific needs. +If you need a fundamental explanation of what smart contracts are and how they work, we recommend contacting our team to join our Learn World Blockchain course. Our experts will guide you through the basics, ensuring you have a solid foundation before diving into development. For a practical guide, please visit [deploying a contract](./3_deploying_a_contract.md). SettleMint's smart contract sets include both Hardhat and Foundry, enabling you to compile, test, and deploy using your preferred framework or a combination of both. This flexibility allows you to optimize your development process to best suit your project needs and preferences. @@ -20,8 +20,8 @@ The following is a high-level overview of smart contract development processes a ### 1. Deploying a Smart Contract Set - - **Add Smart Contract Set**: Navigate to the smart contract sets page and press the button "Add Smart Contract Set." - - **Picking Your Template**: Pick the template of your choice. +- **Add Smart Contract Set**: Navigate to the smart contract sets page and press the button "Add Smart Contract Set." +- **Picking Your Template**: Pick the template of your choice. ### 2. Compiling and Configuring The Smart Contract @@ -30,6 +30,7 @@ The following is a high-level overview of smart contract development processes a - **Purpose**: Tailors the deployment process to your specific requirements and ensures your contract can run on the blockchain. ### 3. Deploying and Interacting with the Smart Contract + - **Deploying**: Upload your compiled smart contract to a blockchain network. - **Interacting**: Once deployed, interact with the smart contract through transactions that call its functions. - **Purpose**: Makes the contract accessible on the blockchain so users can interact with it and utilize its features to perform actions defined in its logic. @@ -55,7 +56,8 @@ Hardhat is a development environment for EVM software. It provides a flexible an 3. **Compile and Deploy Contract**: Convert your Solidity code into bytecode and deploy your compiled contract to the blockchain network of your choice. ## Key Points + - **Smart Contracts**: Self-executing programs with predefined rules. - **Compiling and Configuring**: Converts code into a format the blockchain can run and tailors the deployment process. - **Deploying and Interacting**: Uploads the compiled code to the blockchain and makes it accessible for interaction. -By following these steps and using the appropriate tools, you can easily create, compile, and deploy smart contracts to automate and secure your business processes on the blockchain. \ No newline at end of file + By following these steps and using the appropriate tools, you can easily create, compile, and deploy smart contracts to automate and secure your business processes on the blockchain. diff --git a/docs/using-platform/6_add_smart_contract_sets/1_ smart_contract_templates.md b/docs/using-platform/6_add_smart_contract_sets/1_smart_contract_templates.md similarity index 100% rename from docs/using-platform/6_add_smart_contract_sets/1_ smart_contract_templates.md rename to docs/using-platform/6_add_smart_contract_sets/1_smart_contract_templates.md diff --git a/docs/using-platform/7_integrated-development-environment.md b/docs/using-platform/7_integrated-development-environment.md index 1031f85c..135a111b 100644 --- a/docs/using-platform/7_integrated-development-environment.md +++ b/docs/using-platform/7_integrated-development-environment.md @@ -2,7 +2,7 @@ The SettleMint Integrated Development Environment (IDE) is a powerful tool that simplifies the development of your smart contracts. It includes pre-built smart contract set templates for a certain use case, which are easily customizable to match your specific use case. The IDE also includes compilation and migration scripts that drastically simplify deployment to the relevant blockchain. -When you [add a smart contract set](6_create-smart-contract-set.md), you get an instance of the IDE that is configured to the blockchain and smart contract set templates of your choice. Go to the **IDE tab** on the **Smart contract sets details page** to access it. +When you [add a smart contract set](./6_add_smart_contract_sets/0_smart_contracts.md), you get an instance of the IDE that is configured to the blockchain and smart contract set templates of your choice. Go to the **IDE tab** on the **Smart contract sets details page** to access it. The IDE programming languages for smart contracts differ depending on the protocol. For blockchain networks that are EVM (Ethereum Virtual Machine) compatible, and are listed below, the programming language used is Solidity.