Merge pull request #1112 from multiversx/TOOL-601-update-docs-for-mxpy

danielailie · web-flow · commit 85bfb2167526 · 2025-06-05T15:34:05.000+03:00
Tool 601 update docs for mxpy
diff --git a/docs/developers/data/code-metadata.md b/docs/developers/data/code-metadata.md
@@ -31,7 +31,7 @@ When deploying (or upgrading) a smart contract using **mxpy**, its default _code
 - `--metadata-payable` - mark the contract as `payable`
 - `--metadata-payable-by-sc` - mark the contract as `payable by smart contracts`
 
-For more information, please follow [mxpy CLI](/sdk-and-tools/sdk-py/mxpy-cli).
+For more information, please follow [mxpy CLI](/sdk-and-tools/mxpy/mxpy-cli).
 
 [comment]: # (mx-context-auto)
 
diff --git a/docs/developers/relayed-transactions.md b/docs/developers/relayed-transactions.md
@@ -114,7 +114,7 @@ Here's an example of a relayed v3 transaction. Its intent is to call the `add` m
 ### Preparing relayed transactions using the SDKs
 
 The SDKs have built-in support for relayed transactions. Please follow:
- - [mxpy support](/sdk-and-tools/sdk-py/mxpy-cli/#relayed-transactions-v3)
+ - [mxpy support](/sdk-and-tools/mxpy/mxpy-cli/#relayed-transactions-v3)
  - [sdk-py support](/sdk-and-tools/sdk-py/sdk-py-cookbook/#relayed-transactions)
  - [sdk-js v14 support](/sdk-and-tools/sdk-js/sdk-js-cookbook#relayed-transactions)
  - [sdk-js v13 support (legacy)](/sdk-and-tools/sdk-js/sdk-js-cookbook-v13#preparing-a-relayed-transaction)
diff --git a/docs/developers/reproducible-contract-builds.md b/docs/developers/reproducible-contract-builds.md
@@ -174,7 +174,7 @@ A more straightforward alternative to the previous bash script is to use **mxpy*
 
 First, make sure you have the:
 
-- latest [mxpy](/sdk-and-tools/sdk-py/installing-mxpy) installed,
+- latest [mxpy](/sdk-and-tools/mxpy/installing-mxpy) installed,
 - latest [docker engine](https://docs.docker.com/engine/install/) installed.
 
 Then, use the `reproducible-build` command (below, the image tag is just an example):
@@ -227,11 +227,11 @@ Please note that as a **Beta** feature still in development, certain steps descr
 :::
 
 :::tip
-Make sure that you have the latest `mxpy` installed. In order to install mxpy, follow the instructions at [install mxpy](/sdk-and-tools/sdk-py/installing-mxpy).
+Make sure that you have the latest `mxpy` installed. In order to install mxpy, follow the instructions at [install mxpy](/sdk-and-tools/mxpy/installing-mxpy).
 :::
 
 1. The contract must be deterministically built as described [above](/developers/reproducible-contract-builds#building-via-docker-reproducible-build).
-2. To start with the verification process, we need to first deploy the smart contract. For deploying contracts have a look [here](/sdk-and-tools/sdk-py/smart-contract-interactions/#deploy--upgrade).
+2. To start with the verification process, we need to first deploy the smart contract. For deploying contracts have a look [here](/sdk-and-tools/mxpy/mxpy-cli#deploying-a-smart-contract).
 3. Upon deploying, the output will not only provide information such as the transaction hash and data, but also the address of the newly deployed contract.
 4. In order to verify your contract the command you have to use is (below, the image tag is just an example):
 
diff --git a/docs/developers/sc-calls-format.md b/docs/developers/sc-calls-format.md
@@ -128,7 +128,7 @@ There are multiple tools that one can use in order to convert an address into he
 
 ### Converting addresses using mxpy
 
-Make sure you have `mxpy` [installed](/sdk-and-tools/sdk-py/installing-mxpy).
+Make sure you have `mxpy` [installed](/sdk-and-tools/mxpy/installing-mxpy).
 
 ```bash
 mxpy wallet bech32 --decode erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th
diff --git a/docs/developers/setup-local-testnet.md b/docs/developers/setup-local-testnet.md
@@ -19,7 +19,7 @@ If not specified otherwise, the localnet starts with two shards plus the metacha
 
 ## Prerequisites: mxpy
 
-In order to install **mxpy**, follow [these instructions](/sdk-and-tools/sdk-py/installing-mxpy).
+In order to install **mxpy**, follow [these instructions](/sdk-and-tools/mxpy/installing-mxpy).
 
 :::note
 This guide assumes you are using `mxpy v9.7.1` or newer.
diff --git a/docs/sdk-and-tools/mxpy/installing-mxpy.md b/docs/sdk-and-tools/mxpy/installing-mxpy.md
diff --git a/docs/sdk-and-tools/mxpy/mxpy-cli.md b/docs/sdk-and-tools/mxpy/mxpy-cli.md
@@ -5,10 +5,16 @@ title: mxpy CLI cookbook
 
 [comment]: # (mx-abstract)
 
+
+
 ## mxpy (Command Line Interface)
 
 **mxpy**, as a command-line tool, can be used to simplify and automate the interaction with the MultiversX network - it can be easily used in shell scripts, as well. It implements a set of **commands**, organized within **groups**.
 
+:::important
+In order to migrate to the newer `mxpy`, please follow [the migration guide](https://github.com/multiversx/mx-sdk-py-cli/issues?q=label:migration).
+:::
+
 The complete Command Line Interface is listed [**here**](https://github.com/multiversx/mx-sdk-py-cli/blob/main/CLI.md). Command usage and description are available through the `--help` or `-h` flags.
 
 For example:
diff --git a/docs/sdk-and-tools/mxpy/smart-contract-interactions.md b/docs/sdk-and-tools/mxpy/smart-contract-interactions.md
@@ -28,7 +28,7 @@ Let's take the following example:
 
 ### mxpy
 
-We're going to use [**mxpy**](/sdk-and-tools/sdk-py/mxpy-cli) to deploy the contract. Follow the installation guide [here](/sdk-and-tools/sdk-py/installing-mxpy) - make sure to use the latest version available.
+We're going to use [**mxpy**](/sdk-and-tools/mxpy/mxpy-cli) to deploy the contract. Follow the installation guide [here](/sdk-and-tools/mxpy/installing-mxpy) - make sure to use the latest version available.
 
 [comment]: # (mx-context-auto)
 
diff --git a/docs/sdk-and-tools/overview.md b/docs/sdk-and-tools/overview.md
@@ -33,7 +33,6 @@ Note that Rust is also the recommended programming language for writing Smart Co
 | [sdk-js cookbook](/sdk-and-tools/sdk-js/sdk-js-cookbook)                                             | Learn how to handle common tasks by using sdk-js.   |
 | [Extending sdk-js](/sdk-and-tools/sdk-js/extending-sdk-js)                                               | How to extend and tailor certain modules of sdk-js. |
 | [Writing and testing sdk-js interactions](/sdk-and-tools/sdk-js/writing-and-testing-sdk-js-interactions) | Write sdk-js interactions for Visual Studio Code    |
-| [sdk-js migration guides](/sdk-and-tools/sdk-js/sdk-js-migration-guides)                                 | Migrate from sdk-js v9.x to v10+                    |
 | [sdk-js signing providers](/sdk-and-tools/sdk-js/sdk-js-signing-providers)                               | Integrate sdk-js signing providers.                 |
 
 In addition to sdk-js, one could use the following Javascript library for performing wallet operations via CLI:
@@ -66,10 +65,8 @@ You might also want to have a look over [**xSuite**](https://xsuite.dev), a tool
 
 | Name                                                                             | Description                               |
 | -------------------------------------------------------------------------------- | ----------------------------------------- |
-| [mxpy](/sdk-and-tools/sdk-py/)                                                   | High level overview about mxpy.           |
-| [Installing mxpy](/sdk-and-tools/sdk-py/installing-mxpy)                         | How to install and get started with mxpy. |
-| [mxpy cli](/sdk-and-tools/sdk-py/mxpy-cli)                                       | How to use the Command Line Interface.    |
-| [Smart contract interactions](/sdk-and-tools/sdk-py/smart-contract-interactions) | Interact with Smart Contract.             |
+| [Installing mxpy](/sdk-and-tools/mxpy/installing-mxpy)                         | How to install and get started with mxpy. |
+| [mxpy cli](/sdk-and-tools/mxpy/mxpy-cli)                                       | How to use the Command Line Interface.    |
 
 [comment]: # (mx-context-auto)
 
diff --git a/docs/sdk-and-tools/sdk-js/migration-guides.md b/docs/sdk-and-tools/sdk-js/migration-guides.md
diff --git a/docs/sdk-and-tools/sdk-py/migration-guides.md b/docs/sdk-and-tools/sdk-py/migration-guides.md
diff --git a/docs/sdk-and-tools/sdk-py/sdk-py-cookbook-v0.md b/docs/sdk-and-tools/sdk-py/sdk-py-cookbook-v0.md
@@ -12,6 +12,10 @@ pagination_prev: sdk-and-tools/sdk-py/sdk-py
 
 This page will guide you through the process of handling common tasks using the MultiversX Python SDK (libraries) **v0 (legacy, previous version)**.
 
+:::important
+In order to migrate to the newer `sdk-py v1`, please follow [the migration guide](https://github.com/multiversx/mx-sdk-py/issues?q=label:migration).
+:::
+
 :::note
 All examples depicted here are captured in **(interactive) [Jupyter notebooks](https://github.com/multiversx/mx-sdk-py/blob/main/examples/Cookbook.ipynb)**.
 :::
diff --git a/docs/sdk-and-tools/sdk-py/sdk-py-cookbook-v1.md b/docs/sdk-and-tools/sdk-py/sdk-py-cookbook-v1.md
@@ -2,7 +2,7 @@
 id: sdk-py-cookbook
 title: Cookbook (v1)
 pagination_prev: sdk-and-tools/sdk-py/sdk-py-cookbook-v0
-pagination_next: sdk-and-tools/sdk-py/installing-mxpy
+pagination_next: sdk-and-tools/mxpy/installing-mxpy
 ---
 
 [comment]: # (mx-abstract)
@@ -13,6 +13,10 @@ pagination_next: sdk-and-tools/sdk-py/installing-mxpy
 
 This page will guide you through the process of handling common tasks using the MultiversX Python SDK (libraries) **v1 (latest, stable version)**.
 
+:::important	
+This cookbook makes use of `sdk-py v1`. In order to migrate from `sdk-py v0` to `sdk-py v1`, please also follow [the migration guide](https://github.com/multiversx/mx-sdk-py/issues?q=label:migration).	
+:::
+
 :::note
 All examples depicted here are captured in **(interactive) [Jupyter notebooks](https://github.com/multiversx/mx-sdk-py/blob/main/examples/v1.ipynb)**.
 :::
diff --git a/docs/sovereign/software-dependencies.md b/docs/sovereign/software-dependencies.md
@@ -28,7 +28,7 @@ sudo pipx ensurepath --global
 
 ### mxpy
 
-Ensure you are using the latest version of mxpy. Follow the installation or upgrade instructions provided [here](/sdk-and-tools/sdk-py/installing-mxpy#install-using-pipx) if you haven't done so already.
+Ensure you are using the latest version of mxpy. Follow the installation or upgrade instructions provided [here](/sdk-and-tools/mxpy/installing-mxpy#install-using-pipx) if you haven't done so already.
 
 ### multiversx-sdk
 
diff --git a/docs/validators/staking/staking.md b/docs/validators/staking/staking.md
@@ -82,7 +82,7 @@ Make sure `mxpy` is installed by issuing this command on a terminal:
 mxpy --version
 ```
 
-If `mxpy` is not installed (`command not found`), please follow [these instructions](/sdk-and-tools/sdk-py/installing-mxpy).
+If `mxpy` is not installed (`command not found`), please follow [these instructions](/sdk-and-tools/mxpy/installing-mxpy).
 
 Make sure `mxpy` is installed and has the latest version before continuing.
 
@@ -92,7 +92,7 @@ Make sure `mxpy` is installed and has the latest version before continuing.
 
 To send transactions on your behalf _without_ using the online MultiversX Wallet, `mxpy` must be able to sign for you. For this reason, you have to generate a PEM file using your Wallet mnemonic.
 
-Please follow the guide [Deriving the Wallet PEM file](/sdk-and-tools/sdk-py/mxpy-cli#converting-a-wallet). Make sure you know exactly where the PEM file was generated, because you'll need to reference its path in the `mxpy` commands.
+Please follow the guide [Deriving the Wallet PEM file](/sdk-and-tools/mxpy/mxpy-cli#converting-a-wallet). Make sure you know exactly where the PEM file was generated, because you'll need to reference its path in the `mxpy` commands.
 
 After the PEM file was generated, you can issue transactions from `mxpy` directly.
 
diff --git a/docs/validators/staking/unjailing.md b/docs/validators/staking/unjailing.md
@@ -125,15 +125,15 @@ unJail@<BLS1>@<BLS2>@…@<BLS99>
 
 Submitting the unjailing transaction using `mxpy` avoids having to write the "Data" field manually. Instead, the transaction is constructed automatically by `mxpy` and submitted to the network directly, in a single command.
 
-Make sure `mxpy` is installed and has the latest version before continuing. If `mxpy` is not installed, please follow [these instructions](/sdk-and-tools/sdk-py/installing-mxpy).
+Make sure `mxpy` is installed and has the latest version before continuing. If `mxpy` is not installed, please follow [these instructions](/sdk-and-tools/mxpy/installing-mxpy).
 
 [comment]: # (mx-context-auto)
 
 ## **Your Wallet PEM file**
 
 To send transactions on your behalf _without_ using the online MultiversX Wallet, `mxpy` must be able to sign for you. For this reason, you have to generate a PEM file using your Wallet mnemonic.
 
-Please follow the guide [Deriving the Wallet PEM file](/sdk-and-tools/sdk-py/mxpy-cli). Make sure you know exactly where the PEM file was generated, because you'll need to reference its path in the `mxpy` commands.
+Please follow the guide [Deriving the Wallet PEM file](/sdk-and-tools/mxpy/mxpy-cli). Make sure you know exactly where the PEM file was generated, because you'll need to reference its path in the `mxpy` commands.
 
 After the PEM file was generated, you can issue transactions from `mxpy`directly.
 
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -420,11 +420,15 @@ const config = {
           },
           {
             from: "/sdk-and-tools/sdk-py/configuring-mxpy",
-            to: "/sdk-and-tools/sdk-py/mxpy-cli",
+            to: "/sdk-and-tools/mxpy/mxpy-cli",
+          },
+          {
+            from: "/sdk-and-tools/sdk-py/mxpy-cli",
+            to: "/sdk-and-tools/mxpy/mxpy-cli",
           },
           {
             from: "/sdk-and-tools/sdk-py/deriving-the-wallet-pem-file",
-            to: "/sdk-and-tools/sdk-py/mxpy-cli",
+            to: "/sdk-and-tools/mxpy/mxpy-cli",
           },
           {
             from: "/developers/log-events/esdt-events",
diff --git a/sidebars.js b/sidebars.js
@@ -211,10 +211,14 @@ const sidebars = {
                       "sdk-and-tools/sdk-py/sdk-py-cookbook",
                     ]
                   },
-                  "sdk-and-tools/sdk-py/installing-mxpy",
-                  "sdk-and-tools/sdk-py/mxpy-cli",
-                  "sdk-and-tools/sdk-py/smart-contract-interactions",
-                  "sdk-and-tools/sdk-py/sdk-py-migration-guides",
+                ],
+              },
+              {
+                type: "category",
+                label: "Mxpy CLI",
+                items: [
+                  "sdk-and-tools/mxpy/installing-mxpy",
+                  "sdk-and-tools/mxpy/mxpy-cli",
                 ],
               },
               {
@@ -236,7 +240,6 @@ const sidebars = {
                   },
                   "sdk-and-tools/sdk-js/extending-sdk-js",
                   "sdk-and-tools/sdk-js/writing-and-testing-sdk-js-interactions",
-                  "sdk-and-tools/sdk-js/sdk-js-migration-guides",
                   "sdk-and-tools/sdk-js/sdk-js-signing-providers",
                 ],
               },
