refactor(tooling-general): Update docs links (#3980)

* refactor(tooling-general): Update docs links * Update sdk/typescript/package.json Co-authored-by: Lucas Tortora <[email protected]> * Update sdk/typescript/README.md Co-authored-by: Lucas Tortora <[email protected]> * chore: Update missing links * chore: Update cafe links * update validator_tool.md * clean up * remove old link --------- Co-authored-by: Lucas Tortora <[email protected]>
iotaledger · Nov 12, 2024 · f9f7c4f · f9f7c4f
1 parent aa1524f
commit f9f7c4f
Show file tree

Hide file tree

Showing 22 changed files with 41 additions and 41 deletions.
diff --git a/apps/wallet/src/shared/constants.ts b/apps/wallet/src/shared/constants.ts
@@ -4,7 +4,7 @@
 
 export const ToS_LINK = 'https://www.iota.org/terms-of-use';
 export const PRIVACY_POLICY_LINK = 'https://www.iota.org/privacy-policy';
-export const FAQ_LINK = 'https://wiki.iota.org/';
+export const FAQ_LINK = 'https://docs.iota.org/about-iota/iota-wallet/FAQ ';
 
 // number of epochs before earning
 // Staking Rewards Redeemable

diff --git a/apps/wallet/src/ui/app/pages/home/nft-details/index.tsx b/apps/wallet/src/ui/app/pages/home/nft-details/index.tsx
@@ -58,11 +58,12 @@ function NFTDetailsPage() {
     const isPending = isNftLoading || isPendingDisplay || isGuardLoading;
 
     function handleMoreAboutKiosk() {
-        window.open('https://wiki.iota.org/', '_blank');
+        window.open('https://docs.iota.org/references/ts-sdk/kiosk/', '_blank');
     }
 
     function handleMarketplace() {
-        window.open('https://wiki.iota.org/', '_blank');
+        // TODO: https://github.com/iotaledger/iota/issues/4024
+        window.open('https://docs.iota.org/references/ts-sdk/kiosk/', '_blank');
     }
 
     function handleSend() {

diff --git a/crates/iota-sdk/README.md b/crates/iota-sdk/README.md
@@ -59,7 +59,7 @@ Unless otherwise specified, most of these examples assume `Rust` and `cargo` are
 
 In the root folder of the `iota` repository (or in the `iota-sdk` crate folder), you can individually run examples using the command `cargo run --example filename` (without `.rs` extension). For example:
 
-- `cargo run --example iota_client` -- this one requires a local Iota network running (see [#Connecting to Iota Network](https://wiki.iota.cafe/developer/getting-started/local-network#start-the-local-network). If you do not have a local Iota network running, please skip this example.
+- `cargo run --example iota_client` -- this one requires a local Iota network running (see [#Connecting to Iota Network](https://docs.iota.org/developer/getting-started/local-network#start-a-local-network). If you do not have a local Iota network running, please skip this example.
 - `cargo run --example coin_read_api`
 - `cargo run --example event_api` -- note that this will subscribe to a stream and thus the program will not terminate unless forced (Ctrl+C)
 - `cargo run --example governance_api`
@@ -80,7 +80,7 @@ The `IotaClientBuilder` struct provides a connection to the JSON-RPC server that
 
 For all available servers, see [here](TODO: https://github.com/iotaledger/iota/issues/1614).
 
-For running a local IOTA network, please follow [this guide](https://wiki.iota.cafe/developer/getting-started/iota-install) for installing IOTA and [this guide](https://wiki.iota.cafe/developer/getting-started/local-network#start-the-local-network) for starting the local IOTA network.
+For running a local IOTA network, please follow [this guide](https://docs.iota.org/developer/getting-started/install-iota) for installing IOTA and [this guide](https://docs.iota.org/developer/getting-started/local-network#start-a-local-network) for starting the local IOTA network.
 
 ```rust
 use iota_sdk::IotaClientBuilder;
@@ -141,15 +141,15 @@ See the programmable transactions [example](https://github.com/iotaledger/iota/b
 
 1. Prepare the environment
 
-   1. Install `iota` binary following the [IOTA installation](https://wiki.iota.cafe/developer/getting-started/iota-install) docs.
-   1. [Connect to IOTA Devnet](https://wiki.iota.cafe/developer/getting-started/connect).
-   1. [Make sure you have two addresses with gas](https://wiki.iota.cafe/developer/getting-started/get-address) by using the `new-address` command to create new addresses:
+   1. Install `iota` binary following the [IOTA installation](https://docs.iota.org/developer/getting-started/install-iota) docs.
+   1. [Connect to IOTA Devnet](https://docs.iota.org/developer/getting-started/connect).
+   1. [Make sure you have two addresses with gas](https://docs.iota.org/developer/getting-started/get-address) by using the `new-address` command to create new addresses:
       ```shell
       iota client new-address ed25519
       ```
       You must specify the key scheme, one of `ed25519` or `secp256k1` or `secp256r1`.
       You can skip this step if you are going to play with a friend. :)
-   1. [Request IOTA tokens](https://wiki.iota.cafe/developer/getting-started/get-coins) for all addresses that will be used to join the game.
+   1. [Request IOTA tokens](https://docs.iota.org/developer/getting-started/get-coins) for all addresses that will be used to join the game.
 
 2. Publish the move contract
 

diff --git a/dapps/kiosk/src/components/Kiosk/KioskCreation.tsx b/dapps/kiosk/src/components/Kiosk/KioskCreation.tsx
@@ -29,7 +29,7 @@ export function KioskCreation({ onCreate }: { onCreate: () => void }) {
                     wallet connects to Testnet and that you have at least 1 IOTA to cover gas fees.
                     You can get test IOTA tokens using{' '}
                     <a
-                        href="https://wiki.iota.org/build/faucet"
+                        href="https://docs.iota.org/references/cli/cheatsheet#faucet--gas"
                         target="_blank"
                         rel="noreferrer"
                         className="underline"

diff --git a/dapps/multisig-toolkit/src/routes/combine-sigs.tsx b/dapps/multisig-toolkit/src/routes/combine-sigs.tsx
@@ -232,7 +232,7 @@ export default function MultiSigCombineSignatureGenerator() {
                     <CardHeader>
                         <CardTitle>IOTA MultiSig Address</CardTitle>
                         <CardDescription>
-                            https://wiki.iota.org/testnet/learn/cryptography/iota-multisig
+                            https://docs.iota.org/developer/cryptography/transaction-auth/multisig
                         </CardDescription>
                     </CardHeader>
                     <CardContent>
@@ -249,7 +249,7 @@ export default function MultiSigCombineSignatureGenerator() {
                     <CardHeader>
                         <CardTitle>IOTA MultiSig Combined Address</CardTitle>
                         <CardDescription>
-                            https://wiki.iota.org/testnet/learn/cryptography/iota-multisig
+                            https://docs.iota.org/developer/cryptography/transaction-auth/multisig
                         </CardDescription>
                     </CardHeader>
                     <CardContent>

diff --git a/dapps/multisig-toolkit/src/routes/multisig-address.tsx b/dapps/multisig-toolkit/src/routes/multisig-address.tsx
@@ -137,7 +137,7 @@ export default function MultiSigAddressGenerator() {
                     <CardHeader>
                         <CardTitle>IOTA MultiSig Address</CardTitle>
                         <CardDescription>
-                            https://wiki.iota.org/testnet/learn/cryptography/iota-multisig
+                            https://docs.iota.org/references/ts-sdk/typescript/cryptography/multisig
                         </CardDescription>
                     </CardHeader>
                     <CardContent>

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 ## Overview
 
-This directory contains the assets required to build and update the [IOTA documentation](https://wiki.iota.org). The directory is split between `content` and `site`. To run the site locally, open the root directory in a terminal or console. Use a package manager to install the required modules:
+This directory contains the assets required to build and update the [IOTA documentation](https://docs.iota.org). The directory is split between `content` and `site`. To run the site locally, open the root directory in a terminal or console. Use a package manager to install the required modules:
 
 ```shell
 pnpm install
@@ -38,11 +38,10 @@ If you'd like to view the Vercel preview before your changes are ready for revie
 
 IOTA is for the community. Contribute for the benefit of all.
 
-- [Docs contributing guidelines](https://wiki.iota.cafe/references/contribute/contribution-process)
-- [Repo contributing guidelines](https://wiki.iota.cafe/contribute-to-iota-repos)
-- [Style guide](https://wiki.iota.cafe/style-guide)
-- [Localization](https://wiki.iota.cafe/localize-iota-docs)
-- [Code of conduct](https://wiki.iota.cafe/code-of-conduct)
+- [Docs contributing guidelines](https://docs.iota.org/references/contribute/contribution-process)
+- [Repo contributing guidelines](https://github.com/iotaledger/iota/blob/develop/CONTRIBUTING.md)
+- [Style guide](https://docs.iota.org/style-guide)
+- [Code of conduct](https://docs.iota.org/code-of-conduct)
 
 ## License
 

diff --git a/examples/custom-indexer/rust/README.md b/examples/custom-indexer/rust/README.md
@@ -2,7 +2,7 @@
 
 This is a complimentary example to the Iota Custom Indexer documentation.
 It demonstrates how to create a custom indexer for the Iota search engine.
-See the [Iota Custom Indexer documentation](https://wiki.iota.org/guides/developer/advanced/custom-indexer) for more information.
+See the [Iota Custom Indexer documentation](https://docs.iota.org/developer/advanced/custom-indexer) for more information.
 
 ## Prerequisites
 

diff --git a/examples/tic-tac-toe/ui/README.md b/examples/tic-tac-toe/ui/README.md
@@ -22,7 +22,7 @@ Client dApp using the following tools:
 - [Vite](https://vitejs.dev/) for build tooling
 - [Radix UI](https://www.radix-ui.com/) for pre-built UI components
 - [ESLint](https://eslint.org/)
-- [`@iota/dapp-kit`](https://wiki.iota.org/references/ts-sdk/dapp-kit) for connecting to
+- [`@iota/dapp-kit`](https://docs.iota.org/references/ts-sdk/dapp-kit) for connecting to
   wallets and loading data
 - [pnpm](https://pnpm.io/) for package management
 

diff --git a/external-crates/move/crates/move-analyzer/editors/code/README.md b/external-crates/move/crates/move-analyzer/editors/code/README.md
@@ -22,7 +22,7 @@ the pre-built move-analyzer binary is not available for your platform or if you
 binary stored in a different location.
 
 If you want to build and test Move code using the extension, you must install the `iota` binary on
-your machine - see [here](https://wiki.iota.org/guides/developer/getting-started/iota-install) for
+your machine - see [here](https://docs.iota.org/developer/getting-started/install-iota) for
 instructions. The extension assumes that the `iota` binary is in your system path, but you can set
 its custom location location using VSCode's settings (`⌘` + `,` on macOS, or use the menu item _Code >
 Preferences > Settings_). Search for the `move.iota.path` user setting, set it to the new location of
@@ -41,7 +41,7 @@ This can be done in two steps:
 1. Install the move-analyzer installation prerequisites for your platform. They are the same
    as prerequisites for Iota installation - for Linux, macOS and Windows these prerequisites and
    their installation instructions can be found
-   [here](https://wiki.iota.org/guides/developer/getting-started/iota-install#additional-prerequisites-by-operating-system)
+   [here](https://docs.iota.org/developer/getting-started/install-iota#additional-prerequisites-by-operating-system)
 2. Invoke `cargo install --git https://github.com/iotaledger/iota iota-move-lsp` to install the
    `move-analyzer` language server in your Cargo binary directory, which is typically located
    in the `~/.cargo/bin` (macOS/Linux) or `C:\Users\USER\.cargo\bin` (Windows) directory.

diff --git a/nre/helm/README.md b/nre/helm/README.md
@@ -67,7 +67,7 @@ _Resource Reccomendations_
 
 ### Containers
 
-**iota-indexer-writer** - Indexer writer syncs and indexes iota checkpoint data into a Postgres database. Checkpoint data can be pulled from a fullnode or a cloud provider hosted bucket. More info and available buckets can be found in iota [doc site](https://wiki.iota.org/guides/developer/advanced/custom-indexer#remote-reader).
+**iota-indexer-writer** - Indexer writer syncs and indexes iota checkpoint data into a Postgres database. Checkpoint data can be pulled from a fullnode or a cloud provider hosted bucket. More info and available buckets can be found in iota [doc site](https://docs.iota.org/developer/advanced/custom-indexer#remote-reader).
 
 ### Resource Recommendations
 

diff --git a/nre/validator_tool.md b/nre/validator_tool.md
@@ -6,7 +6,7 @@ This document is focused on using Validator Tool.
 
 ## Preparation
 
-1. Make sure you have completed all the [prerequisites](https://wiki.iota.org/devnet/build/install).
+1. Make sure you have completed all the [prerequisites](https://docs.iota.org/developer/getting-started/install-iota#prerequisites).
 
 2. Build the `iota` binary, which you will need for the genesis ceremony. This step can be done on any machine you like. It does not have to be done on the machine on which you will run the validator.
 
@@ -35,7 +35,7 @@ This document is focused on using Validator Tool.
       b. `active_address` is correct in `client.yaml`.
       b. `iota.keystore` contains your account key pair.
 
-   If at this point you can't find where `client.yaml` or `iota.keystore` is or have other questions, read [Iota Client CLI tutorial](https://wiki.iota.org/devnet/build/cli-client).
+   If at this point you can't find where `client.yaml` or `iota.keystore` is or have other questions, read [Iota Client CLI tutorial](https://docs.iota.org/references/cli/client).
 
 ```bash
 $IOTA_BINARY client

diff --git a/sdk/create-dapp/README.md b/sdk/create-dapp/README.md
@@ -27,7 +27,7 @@ you including:
 - [Vite](https://vitejs.dev/)
 - [Radix UI](https://www.radix-ui.com/)
 - [ESLint](https://eslint.org/)
-- [`@iota/dapp-kit`](https://wiki.iota.org/references/ts-sdk/dapp-kit)
+- [`@iota/dapp-kit`](https://docs.iota.org/references/ts-sdk/dapp-kit)
 
 These templates are still new, and would love to get feedback and suggestions for improvements or
 future templates. Please open an issue on GitHub if you have any feedback.
diff --git a/sdk/create-dapp/package.json b/sdk/create-dapp/package.json
@@ -2,6 +2,7 @@
     "name": "@iota/create-dapp",
     "author": "IOTA Foundation <[email protected]>",
     "description": "A CLI for creating new IOTA dApps",
+    "homepage": "https://docs.iota.org/references/ts-sdk/typescript/",
     "version": "0.2.0",
     "license": "Apache-2.0",
     "files": [

diff --git a/sdk/create-dapp/templates/react-client-dapp/README.md b/sdk/create-dapp/templates/react-client-dapp/README.md
@@ -8,7 +8,7 @@ Client dApp using the following tools:
 - [Vite](https://vitejs.dev/) for build tooling
 - [Radix UI](https://www.radix-ui.com/) for pre-built UI components
 - [ESLint](https://eslint.org/)
-- [`@iota/dapp-kit`](https://wiki.iota.org/references/ts-sdk/dapp-kit) for
+- [`@iota/dapp-kit`](https://docs.iota.org/references/ts-sdk/dapp-kit) for
   connecting to wallets and loading data
 - [pnpm](https://pnpm.io/) for package management
 

diff --git a/sdk/create-dapp/templates/react-e2e-counter/README.md b/sdk/create-dapp/templates/react-e2e-counter/README.md
@@ -8,20 +8,17 @@ Client dApp using the following tools:
 - [Vite](https://vitejs.dev/) for build tooling
 - [Radix UI](https://www.radix-ui.com/) for pre-built UI components
 - [ESLint](https://eslint.org/) for linting
-- [`@iota/dapp-kit`](https://wiki.iota.org/references/ts-sdk/dapp-kit) for
+- [`@iota/dapp-kit`](https://docs.iota.org/references/ts-sdk/dapp-kit) for
   connecting to wallets and loading data
 - [pnpm](https://pnpm.io/) for package management
 
-For a full guide on how to build this dApp from scratch, visit this
-[guide](http://wiki.iota.org/guides/developer/app-examples/e2e-counter#frontend).
-
 ## Deploying your Move code
 
 ### Install IOTA cli
 
 Before deploying your move code, ensure that you have installed the IOTA CLI.
 You can follow the
-[IOTA installation instruction](https://wiki.iota.org/build/install) to get
+[IOTA installation instruction](https://docs.iota.org/developer/getting-started/install-iota) to get
 everything set up.
 
 This template uses `testnet` by default, so we'll need to set up a testnet

diff --git a/sdk/dapp-kit/README.md b/sdk/dapp-kit/README.md
@@ -4,7 +4,7 @@ The IOTA dApp Kit is a set of React components, hooks, and utilities that make i
 dApp for the IOTA ecosystem. It provides hooks and components for querying data from the IOTA
 blockchain, and connecting to IOTA wallets.
 
-See https://wiki.iota.org/references/ts-sdk/typescript for full documentation
+See https://docs.iota.org/references/ts-sdk/typescript for full documentation
 
 ### Core Features
 
@@ -68,7 +68,7 @@ dApp up and running.
 To use our provided UI components, you will need to import the dApp Kit's CSS stylesheet into your
 dApp as shown below. For more information regarding customization options, check out the respective
 documentation pages for the components and
-[themes](https://wiki.iota.org/references/ts-sdk/dapp-kit/themes).
+[themes](https://docs.iota.org/references/ts-sdk/dapp-kit/themes).
 
 ```tsx
 import '@iota/dapp-kit/dist/index.css';

diff --git a/sdk/dapp-kit/package.json b/sdk/dapp-kit/package.json
@@ -2,6 +2,7 @@
     "name": "@iota/dapp-kit",
     "author": "IOTA Foundation <[email protected]>",
     "description": "A collection of React hooks and components for interacting with the IOTA blockchain and wallets.",
+    "homepage": "https://docs.iota.org/references/ts-sdk/dapp-kit/",
     "version": "0.3.0",
     "license": "Apache-2.0",
     "files": [

diff --git a/sdk/kiosk/README.md b/sdk/kiosk/README.md
@@ -3,6 +3,6 @@
 This Kiosk SDK library provides different utilities to interact/create/manage a
 [Kiosk](https://github.com/iotaledger/iota/tree/main/kiosk).
 
-[You can read the documentation and see examples by clicking here.](https://wiki.iota.org/references/ts-sdk/kiosk)
+[You can read the documentation and see examples by clicking here.](https://docs.iota.org/references/ts-sdk/kiosk)
 
-[If you are migrating from `0.6.x`, you can follow these instructions](https://wiki.iota.org/references/ts-sdk/kiosk/from-v1)
+[If you are migrating from `0.6.x`, you can follow these instructions](https://docs.iota.org/references/ts-sdk/kiosk/from-v1)
diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md
@@ -1,7 +1,7 @@
 # Docs site
 
 For more complete docs, visit the
-[IOTA TypeScript SDK docs](https://wiki.iota.org/references/ts-sdk/)
+[IOTA TypeScript SDK docs](https://docs.iota.org/references/ts-sdk/typescript/)
 
 # IOTA TypeScript SDK
 
@@ -126,7 +126,7 @@ await client.getCoins({
 
 For local development, you can run `cargo run --bin --with-faucet --force-regenesis` to spin up a
 local network with a local validator, a fullnode, and a faucet server. Refer to
-[this guide](https://wiki.iota.org/build/iota-local-network) for more information.
+[this guide](https://docs.iota.org/developer/getting-started/local-network) for more information.
 
 ```typescript
 import { getFullnodeUrl, IotaClient } from '@iota/iota-sdk/client';
@@ -172,7 +172,7 @@ await requestIotaFromFaucetV0({
 ## Writing APIs
 
 For a primer for building transactions, refer to
-[this guide](https://wiki.iota.org/build/prog-trans-ts-sdk).
+[this guide](https://docs.iota.org/references/ts-sdk/typescript/transaction-building/basics).
 
 ### Transfer Object
 

diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
@@ -2,6 +2,7 @@
     "name": "@iota/iota-sdk",
     "author": "IOTA Foundation <[email protected]>",
     "description": "IOTA TypeScript API",
+    "homepage": "https://docs.iota.org/references/ts-sdk/typescript/",
     "version": "0.3.0",
     "license": "Apache-2.0",
     "sideEffects": false,

diff --git a/sdk/wallet-standard/README.md b/sdk/wallet-standard/README.md
@@ -3,4 +3,4 @@
 A suite of standard utilities for implementing wallets and libraries based on the
 [Wallet Standard](https://github.com/wallet-standard/wallet-standard/).
 
-**Documentation:** https://wiki.iota.org/standards/wallet-standard
+**Documentation:** https://docs.iota.org/developer/standards/wallet-standard