docs: Update some hyperlinks to reference the new documentation hub (#…

…1520) * docs: Updated high-level doc links in README files * docs: updating "/guide/" based doc hyperlinks * docs: update "/sway/" and "/forc/" related doc urls * docs: update "fuels-rs" doc links * docs: update quickstart doc links * docs: updated the quickstart docs link * docs: added the changeset --------- Co-authored-by: Anderson Arboleya <anderson@arboleya.me>
FuelLabs · Dec 18, 2023 · 55e8301 · 55e8301
1 parent e236fc8
commit 55e8301
Show file tree

Hide file tree

Showing 32 changed files with 51 additions and 49 deletions.
diff --git a/.changeset/selfish-wombats-dance.md b/.changeset/selfish-wombats-dance.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/README.md b/README.md
@@ -7,20 +7,20 @@
 
 [![test](https://github.com/FuelLabs/fuels-ts/actions/workflows/test.yaml/badge.svg)](https://github.com/FuelLabs/fuels-ts/actions/workflows/test.yaml)
 [![npm](https://img.shields.io/npm/v/fuels)](https://www.npmjs.com/package/fuels)
-[![docs](https://img.shields.io/badge/docs-fuels.ts-brightgreen.svg?style=flat)](https://fuellabs.github.io/fuels-ts/)
+[![docs](https://img.shields.io/badge/docs-fuels.ts-brightgreen.svg?style=flat)](https://docs.fuel.network/docs/fuels-ts/)
 [![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)
 
 # Resources
 
-The [documentation](https://fuellabs.github.io/fuels-ts) site is your main stop for resources.
+The [documentation](https://docs.fuel.network/docs/fuels-ts/) site is your main stop for resources.
 
-- [Quickstart](https://fuellabs.github.io/fuel-docs/master/quickstart/developer-quickstart.html)
-- [Documentation](https://fuellabs.github.io/fuels-ts)
-  - [Wallets](https://fuellabs.github.io/fuels-ts/guide/wallets/)
-  - [Contracts](https://fuellabs.github.io/fuels-ts/guide/contracts/)
-  - [Scripts](https://fuellabs.github.io/fuels-ts/guide/scripts/)
-  - [Predicates](https://fuellabs.github.io/fuels-ts/guide/predicates/)
-  - [ABI Typegen](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/)
+- [Quickstart](https://docs.fuel.network/docs/intro/quickstart-contract/)
+- [Documentation](https://docs.fuel.network/docs/fuels-ts/)
+  - [Wallets](https://docs.fuel.network/docs/fuels-ts/wallets/)
+  - [Contracts](https://docs.fuel.network/docs/fuels-ts/contracts/)
+  - [Scripts](https://docs.fuel.network/docs/fuels-ts/scripts/)
+  - [Predicates](https://docs.fuel.network/docs/fuels-ts/predicates/)
+  - [ABI Typegen](https://docs.fuel.network/docs/fuels-ts/abi-typegen/)
 - [Contributing](https://github.com/FuelLabs/fuels-ts/blob/master/CONTRIBUTING.md)
 - [The Fuel Forum](https://forum.fuel.network/)
 - [The Fuel Ecosystem](#the-fuel-ecosystem)
@@ -49,7 +49,7 @@ console.log(new Wallet("0x0000...0000"));
 
 Fuels include some utility commands via built-in CLI tool.
 
-Check the [docs](https://fuellabs.github.io/fuels-ts) for more info.
+Check the [docs](https://docs.fuel.network/docs/fuels-ts/) for more info.
 
 ```console
 $ npm add fuels
@@ -78,8 +78,8 @@ Commands:
 
 Learn more about the Fuel Ecosystem.
 
-- [🌴 Sway](https://fuellabs.github.io/sway/) — The new language, empowering everyone to build reliable and efficient smart contracts
-- [🧰 Forc](https://fuellabs.github.io/sway/v0.30.1/forc/index.html) — The Fuel toolbox: _Build, deploy and manage your sway projects_
+- [🌴 Sway](https://docs.fuel.network/docs/sway/) — The new language, empowering everyone to build reliable and efficient smart contracts
+- [🧰 Forc](https://docs.fuel.network/docs/forc/) — The Fuel toolbox: _Build, deploy and manage your sway projects_
 - [⚙️ Fuel Core](https://github.com/FuelLabs/fuel-core) — The new FuelVM, a blazingly fast blockchain VM
 - [🔗 Fuel Specs](https://github.com/FuelLabs/fuel-specs) — The Fuel protocol specifications
 - [💼 Fuels Wallet](https://github.com/FuelLabs/fuels-wallet) — The Official Fuels Wallet

diff --git a/apps/docs/src/guide/abi-typegen/index.md b/apps/docs/src/guide/abi-typegen/index.md
@@ -2,13 +2,13 @@
   import { data } from '../../versions.data'
   const { forc } = data
   const abiUrl = `
-    https://fuellabs.github.io/sway/v${forc}/book/sway-program-types/smart_contracts.html#the-abi-declaration
+    https://docs.fuel.network/docs/sway/sway-program-types/smart_contracts/#the-abi-declaration
   `
   const contractsUrl = `
-    https://fuellabs.github.io/sway/v${forc}/book/sway-program-types/smart_contracts.html
+    https://docs.fuel.network/docs/sway/sway-program-types/smart_contracts/
   `
   const scriptsUrl = `
-    https://fuellabs.github.io/sway/v${forc}/book/sway-program-types/scripts.html
+    https://docs.fuel.network/docs/sway/sway-program-types/scripts/
   `
 </script>
 

diff --git a/apps/docs/src/guide/contracts/deploying-contracts.md b/apps/docs/src/guide/contracts/deploying-contracts.md
@@ -1,8 +1,8 @@
 <script setup>
   import { data } from '../../versions.data'
   const { forc } = data
-const indexUrl = `https://fuellabs.github.io/sway/v${forc}/book/introduction/index.html`
-  const jsonAbiUrl = `https://fuellabs.github.io/sway/v${forc}/book/introduction/sway_quickstart.html?highlight=abi#abi`
+  const indexUrl = `https://docs.fuel.network/docs/sway/introduction/`
+  const jsonAbiUrl = `https://docs.fuel.network/docs/sway/introduction/sway_quickstart/`
 </script>
 
 # Deploying Contracts

diff --git a/apps/docs/src/guide/predicates/index.md b/apps/docs/src/guide/predicates/index.md
@@ -1,8 +1,8 @@
 <script setup>
   import { data } from '../../versions.data'
   const { forc } = data
-  const introUrl = `https://fuellabs.github.io/sway/v${forc}/book/introduction/index.html`
-  const debugUrl = `https://fuellabs.github.io/sway/v${forc}/book/sway-program-types/predicates.html?#debugging-predicates`
+  const introUrl = `https://docs.fuel.network/docs/sway/introduction/`
+  const debugUrl = `https://docs.fuel.network/docs/sway/sway-program-types/predicates/#debugging-predicates`
 </script>
 
 # Predicates

diff --git a/apps/docs/src/guide/scripts/index.md b/apps/docs/src/guide/scripts/index.md
@@ -2,7 +2,7 @@
   import { data } from '../../versions.data'
   const { forc } = data
   const url = `
-    https://fuellabs.github.io/sway/v${forc}/book/sway-program-types/scripts.html#scripts-and-the-sdks
+    https://docs.fuel.network/docs/sway/sway-program-types/scripts/#scripts-and-the-sdks
   `
 </script>
 

diff --git a/apps/docs/src/guide/scripts/instantiating-a-script.md b/apps/docs/src/guide/scripts/instantiating-a-script.md
@@ -2,7 +2,7 @@
   import { data } from '../../versions.data'
   const { forc } = data
   const url = `
-    https://fuellabs.github.io/sway/v${forc}/book/introduction/index.html
+    https://docs.fuel.network/docs/sway/introduction/
   `
 </script>
 

diff --git a/apps/docs/src/guide/testing/index.md b/apps/docs/src/guide/testing/index.md
@@ -1,7 +1,7 @@
 <script setup>
   import { data } from '../../versions.data'
   const { forc } = data
-  const url = `https://fuellabs.github.io/sway/v${forc}/book/forc/commands/forc_test.html`
+  const url = `https://docs.fuel.network/docs/forc/commands/forc_test/`
 </script>
 
 # Testing
@@ -10,7 +10,7 @@ In order to test your Sway and TS-SDK applications, you can test your code in a
 
 1. Testing with TS-SDK: Compiling you Sway code and connecting to the methods using TS-SDK and JS testing frameworks
 2. Using `forc test` see <a :href="url" target="_blank" rel="noreferrer">the Sway docs</a> for more info
-3. Using [the Rust SDK](https://fuellabs.github.io/fuels-rs/v0.31.1/testing/index.html)
+3. Using [the Rust SDK](https://docs.fuel.network/docs/fuels-rs/testing/)
 
 ### Testing with TS-SDK
 

diff --git a/apps/docs/src/guide/types/index.md b/apps/docs/src/guide/types/index.md
@@ -18,6 +18,6 @@ In this section, you will learn about:
 
 As you progress through the documentation, you may find it helpful to refer back to the following resources:
 
-- [Sway Documentation](https://fuellabs.github.io/sway/): Explore the Sway documentation homepage for an overview of Sway Types, as well as other sections.
+- [Sway Documentation](https://docs.fuel.network/docs/sway/): Explore the Sway documentation homepage for an overview of Sway Types, as well as other sections.
 
 - [The Fuel Book](https://fuelbook.fuel.network/master/index.html): A comprehensive guide to the whole Fuel ecosystem.
diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md
@@ -1,7 +1,7 @@
 <script setup>
   import { data } from './versions.data'
   const { forc, fuels, fuelCore } = data
-  const url = `https://fuellabs.github.io/sway/v${forc}/book/forc/index.html`
+  const url = `https://docs.fuel.network/docs/forc/`
   const logoSrc = './fuel-logo.png'
 </script>
 
@@ -15,7 +15,7 @@ Please visit the Fuel's [installation guide](https://docs.fuel.network/guides/in
 
 ## Developer Quickstart Guide
 
-We recommend starting with the [Developer Quickstart](https://fuellabs.github.io/fuel-docs/master/quickstart/developer-quickstart.html) for a walk through on building your first DApp on Fuel.
+We recommend starting with the [Developer Quickstart](https://docs.fuel.network/docs/intro/quickstart-contract/) for a walk through on building your first DApp on Fuel.
 
 - [Guide](./guide/)
 - [Sample Application](https://github.com/FuelLabs/beta2-quickstart)
@@ -25,7 +25,7 @@ We recommend starting with the [Developer Quickstart](https://fuellabs.github.io
 
 Learn more about the Fuel Ecosystem.
 
-- [🌴 Sway](https://fuellabs.github.io/sway/) the new language. Empowering everyone to build reliable and efficient smart contracts.
+- [🌴 Sway](https://docs.fuel.network/docs/sway/) the new language. Empowering everyone to build reliable and efficient smart contracts.
 - <a :href="url" target="_blank" rel="noreferrer">🧰 Forc</a> the Fuel toolbox. Build, deploy and manage your sway projects.
 - [⚙️ Fuel Core](https://github.com/FuelLabs/fuel-core) the new FuelVM, a blazingly fast blockchain VM.
 - [🔗 Fuel Specs](https://github.com/FuelLabs/fuel-specs) the Fuel protocol specifications.

diff --git a/packages/abi-coder/README.md b/packages/abi-coder/README.md
@@ -18,7 +18,7 @@ This module is responsible for encoding and decoding the Application Binary Inte
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/abi-typegen/README.md b/packages/abi-typegen/README.md
@@ -17,7 +17,7 @@ See the full ABI-spec [here](https://github.com/FuelLabs/fuel-specs/blob/master/
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/abi-typegen/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/abi-typegen/)
 
 ## Installation
 

diff --git a/packages/address/README.md b/packages/address/README.md
@@ -16,7 +16,7 @@ This module contains the utilities for encoding and decoding address and contrac
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/types/address.html)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/types/address/)
 
 ## Usage
 

diff --git a/packages/contract/README.md b/packages/contract/README.md
@@ -16,7 +16,7 @@ This module allows for a simple way to serialize calls and transactions to an on
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/contracts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/contracts/)
 
 ## Usage
 

diff --git a/packages/crypto/README.md b/packages/crypto/README.md
@@ -18,7 +18,7 @@ This module contains the utilities for encrypting and decrypting data objects us
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/errors/README.md b/packages/errors/README.md
@@ -20,7 +20,7 @@ This package contains core utilities regarding throwing errors internally inside
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/hasher/README.md b/packages/hasher/README.md
@@ -18,7 +18,7 @@ This module contains several common hashing utilities.
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/hdwallet/README.md b/packages/hdwallet/README.md
@@ -18,7 +18,7 @@ This module is an implementation of the BIP-0044 and BIP-0032, Multi-Account Hie
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/interfaces/README.md b/packages/interfaces/README.md
@@ -18,7 +18,7 @@ This module contains utilities to manipulate binary data and can be used to help
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/math/README.md b/packages/math/README.md
@@ -20,7 +20,7 @@ Math is based in [bn.js](https://www.npmjs.com/package/bn.js) library, which hel
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/merkle/README.md b/packages/merkle/README.md
@@ -23,7 +23,7 @@ This module contains:
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/mnemonic/README.md b/packages/mnemonic/README.md
@@ -18,7 +18,7 @@ This module contains utilities to import and export BIP 39 mnemonic phrases in c
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/predicate/README.md b/packages/predicate/README.md
@@ -16,7 +16,7 @@ This module allows for a simple way to serialize calls to an on-chain predicate
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/predicates/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/predicates/)
 
 ## Usage
 

diff --git a/packages/program/README.md b/packages/program/README.md
@@ -18,7 +18,7 @@ This module allows for a simple way to serialize calls and transactions to Sway
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/providers/README.md b/packages/providers/README.md
@@ -16,7 +16,7 @@ This module contains common Provider classes and utility functions for connectin
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/providers/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/providers/)
 
 ## Usage
 

diff --git a/packages/signer/README.md b/packages/signer/README.md
@@ -18,7 +18,7 @@ This module contains utilities for secp256-k1 signing, verifying and recovery op
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/transactions/README.md b/packages/transactions/README.md
@@ -18,7 +18,7 @@ This module contains various constants and functions for encoding and decoding s
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -18,7 +18,7 @@ It's a collection of utilities and test utilities that may be useful in other pl
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Installation
 

diff --git a/packages/versions/README.md b/packages/versions/README.md
@@ -26,7 +26,7 @@ Aditionally, the library can be used as a CLI tool to help checking/validating u
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Installation
 

diff --git a/packages/wallet-manager/README.md b/packages/wallet-manager/README.md
@@ -18,7 +18,7 @@ This module is a coordination wrapper to manage multiple wallet `Vaults` and sto
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage
 

diff --git a/packages/wallet/README.md b/packages/wallet/README.md
@@ -16,7 +16,7 @@ This module contains the class to manage a private key and signing for a standar
 
 ## Documentation
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/guide/wallets/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/wallets/)
 
 ## Usage
 

diff --git a/packages/wordlists/README.md b/packages/wordlists/README.md
@@ -18,7 +18,7 @@ This module contains a wordlist for BIP 39 mnemonic phrases, currently limited t
 
 <!-- TODO: Replace this link with specific docs for this package if and when we re-introduce a API reference section to our docs -->
 
-See [Fuels-ts Documentation](https://fuellabs.github.io/fuels-ts/)
+See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/)
 
 ## Usage