From a19fac232d681723baba862a0d52b29aac0a1435 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Wed, 18 Oct 2023 14:50:56 -0600 Subject: [PATCH 01/22] rename CIs, add link checker & linter --- .../workflows/{playwright.yml => guides.yml} | 22 +++- .github/workflows/update-latest.yml | 4 +- .markdownlint.yaml | 3 + .markdownlintignore | 11 ++ docs/guides/docs/installation/codespace.mdx | 22 ++-- docs/guides/docs/installation/index.mdx | 60 ++++++---- .../docs/quickstart/building-a-frontend.mdx | 46 ++++---- .../quickstart/building-a-smart-contract.mdx | 30 ++--- docs/guides/docs/running-a-node/index.mdx | 5 +- .../running-a-node/running-a-beta-4-node.mdx | 24 ++-- .../beta-3-to-beta-4-migration.mdx | 6 +- docs/guides/docs/testnet-migration/index.mdx | 2 +- mlc.json | 20 ++++ package.json | 1 + pnpm-lock.yaml | 110 +++++++++++++++++- 15 files changed, 274 insertions(+), 92 deletions(-) rename .github/workflows/{playwright.yml => guides.yml} (76%) create mode 100644 .markdownlint.yaml create mode 100644 .markdownlintignore create mode 100644 mlc.json diff --git a/.github/workflows/playwright.yml b/.github/workflows/guides.yml similarity index 76% rename from .github/workflows/playwright.yml rename to .github/workflows/guides.yml index 6442311dc..2719a7f2d 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/guides.yml @@ -1,9 +1,29 @@ -name: Playwright Tests +name: Guides Tests on: pull_request: jobs: + ## CHECK LINKS & LINT + check-links-lint: + name: Lint & Check Links + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 + with: + config-file: 'mlc..json' + file-extension: 'mdx' + - uses: ./.github/actions/setup-node + with: + install: false + - name: Install dependencies + run: pnpm install + - name: Lint Check + run: pnpm markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' + + ## QUICKSTART TEST quickstart-test: timeout-minutes: 30 name: build-quickstart-contract diff --git a/.github/workflows/update-latest.yml b/.github/workflows/update-latest.yml index 1fd6e3e56..470d7841e 100644 --- a/.github/workflows/update-latest.yml +++ b/.github/workflows/update-latest.yml @@ -1,4 +1,4 @@ -name: Find Latest File +name: Update Latest Versions on: schedule: @@ -11,7 +11,7 @@ env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} jobs: - find-latest-file: + update-latest-versions: runs-on: ubuntu-latest steps: diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 000000000..59d597fb1 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,3 @@ +'default': true # Default state for all rules +'MD013': false # Disable rule for line length +'MD033': false # Disable rule banning inline HTML diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 000000000..7c8d7d5fc --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1,11 @@ +workflow +docs/latest +docs/sway +docs/builds +docs/fuelup +docs/fuels-rs +docs/fuels-ts +docs/fuels-wallet +docs/fuel-specs +docs/fuel-indexer +docs/fuel-graphql-docs diff --git a/docs/guides/docs/installation/codespace.mdx b/docs/guides/docs/installation/codespace.mdx index b0fd61e9c..8b92086b8 100644 --- a/docs/guides/docs/installation/codespace.mdx +++ b/docs/guides/docs/installation/codespace.mdx @@ -15,22 +15,22 @@ The way to think about [Github Codespaces](https://github.com/features/codespace ### How to set up for a new repo 1. Create a devcontainer.json file. The easiest way is by navigating to the repo and clicking Code → … → Configure dev container - + ![dev container walkthrough](/images/dev-container.gif) 2. Edit the file to include the following features: - + ```json "features": { "ghcr.io/devcontainers/features/common-utils:1": {}, "ghcr.io/FuelLabs/devcontainer-features/fuelup:1.0.1": {}, } ``` - -3. Add any plugins that you want to be installed for this repo under “customizations”. - + +3. Add any plugins that you want to be installed for this repo under “customizations”. + ```json "customizations": { "vscode": { @@ -40,11 +40,11 @@ The way to think about [Github Codespaces](https://github.com/features/codespace } } ``` - + Here are examples that include the Sway LSP plugin. - + 3.1. [https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json](https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json) - + 3.2. [https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json](https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json) ### How to start a codespace @@ -56,10 +56,10 @@ The way to think about [Github Codespaces](https://github.com/features/codespace ![Create codespace walkthrough](/images/create-codespace.gif) -3. This will open a new tab with your codespace. It can take several minutes to start up. +3. This will open a new tab with your codespace. It can take several minutes to start up. + + 3.1. You now have a fully functional remote dev environment with the Fuel toolchain installed! You can use `forc` to build and deploy Sway code, or `fuelup` to manage the toolchain version. You also have the Sway LSP plugin with full feature support for Sway, like syntax highlighting, hover docs, go-to definitions, etc. - 3.1. You now have a fully functional remote dev environment with the Fuel toolchain installed! You can use `forc` to build and deploy Sway code, or `fuelup` to manage the toolchain version. You also have the Sway LSP plugin with full feature support for Sway, like syntax highlighting, hover docs, go-to definitions, etc. - 3.2. Note: if you are working on a large repository and find the codespace is running slow, you can configure it to use a larger instance by clicking Code → … → change machine type on a running instance, or starting a new instance with Code → … → New with options. ### Pricing & billing diff --git a/docs/guides/docs/installation/index.mdx b/docs/guides/docs/installation/index.mdx index d031a9c37..de68c470a 100644 --- a/docs/guides/docs/installation/index.mdx +++ b/docs/guides/docs/installation/index.mdx @@ -8,26 +8,29 @@ parent: # Toolchain installation -This guide will help you to install the Fuel toolchain binaries and prerequisites. +This guide will help you to install the Fuel toolchain binaries and prerequisites. This guide covers the following topics: + 1. [Installing Rust](#installing-rust) 2. [Installing the Fuel toolchain using `fuelup`](#installing-the-fuel-toolchain-using-fuelup) 3. [Setting up a default toolchain](#setting-up-a-default-toolchain) ## Installing Rust -{/* install_rust:example:start */} +{/*install_rust:example:start*/} The Fuel toolchain is built on top of the Rust programming language. To install Rust, you can use the `rustup` tool. -{/* install_rust:example:end */} +{/*install_rust:example:end*/} Run the following command in your shell; this downloads and runs rustup-init.sh, which in turn downloads and runs the correct version of the `rustup-init` executable for your platform. -{/* install_rust_command:example:start */} +{/*install_rust_command:example:start*/} + ```console curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -{/* install_rust_command:example:end */} + +{/*install_rust_command:example:end*/} Check the official Rust documentation to get more information on [installing the Rust toolchain](https://www.rust-lang.org/tools/install). @@ -41,17 +44,19 @@ toolchains and keep them updated. It makes building and maintaining Sway applica ### Running fuelup-init -{/* install_fuelup:example:start */} +{/*install_fuelup:example:start*/} To install the Fuel toolchain, you'll use the `fuelup-init` script. This will install `forc`, `forc-client`, `forc-fmt`, `forc-lsp`, `forc-wallet` as well as `fuel-core` in `~/.fuelup/bin`. -{/* install_fuelup:example:end */} +{/*install_fuelup:example:end*/} -👉 Just paste the following line in your terminal and press _Enter_. +👉 Just paste the following line in your terminal and press *Enter*. + +{/*install_fuelup_command:example:start*/} -{/* install_fuelup_command:example:start */} ```sh curl --proto '=https' --tlsv1.2 -sSf https://install.fuel.network/fuelup-init.sh | sh ``` -{/* install_fuelup_command:example:end */} + +{/*install_fuelup_command:example:end*/} > 🚧 Be aware that currently we do not natively support Windows. If you wish to use `fuelup` on Windows, please use Windows Subsystem for Linux. @@ -71,11 +76,11 @@ If permitted, fuelup-init will configure your PATH for you by running the follow Would you like fuelup-init to modify your PATH variable for you? (N/y) ``` -👉 Press the `Y` key in your terminal and press _Enter_ to modify your PATH. +👉 Press the `Y` key in your terminal and press *Enter* to modify your PATH. ### Checking the installation -After allowing the `fuelup-init` script to modify your `PATH` variable, you will see a lot of information about packages being downloaded and installed. If everything goes as expected you will see the following message: +After allowing the `fuelup-init` script to modify your `PATH` variable, you will see a lot of information about packages being downloaded and installed. If everything goes as expected you will see the following message: ```sh The Fuel toolchain is installed and up to date @@ -90,6 +95,7 @@ To generate completions for your shell, run 'fuelup completions --shell=SHELL'. ```sh fuelup --version ``` + That will output your current `fuelup` version: ```sh @@ -112,7 +118,9 @@ Make sure you have the latest version of `fuelup` so you can access the latest f ```console fuelup self update ``` + Then you will get an output like this: + ```console Fetching binary from https://github.com/FuelLabs/fuelup/releases/download/v0.19.5/fuelup-0.19.5-aarch64-apple-darwin.tar.gz Downloading component fuelup without verifying checksum @@ -126,15 +134,17 @@ The `beta-4` network is the latest Fuel testnet. This includes public infrastruc To properly interact with the `beta-4` network it is necessary to use its corresponding toolchain. -{/* install_beta-4:example:start */} +{/*install_beta-4:example:start*/} 👉 Run the following command to install the `beta-4` toolchain: -{/* install_beta-4:example:end */} +{/*install_beta-4:example:end*/} + +{/*install_beta-4_command:example:start*/} -{/* install_beta-4_command:example:start */} ```console fuelup toolchain install beta-4 ``` -{/* install_beta-4_command:example:end */} + +{/*install_beta-4_command:example:end*/} If the toolchain was successfully installed, you will see this output: @@ -144,17 +154,19 @@ The Fuel toolchain is installed and up to date The toolchain was installed correctly, however is not in use yet. Next, you need to configure `fuelup` to use the `beta-4` toolchain as the default. -{/* set_default_beta-4:example:start */} +{/*set_default_beta-4:example:start*/} 👉 Set `beta-4` as your default toolchain with the following command: -{/* set_default_beta-4:example:end */} +{/*set_default_beta-4:example:end*/} + +{/*set_default_beta-4_command:example:start*/} -{/* set_default_beta-4_command:example:start */} ```console fuelup default beta-4 ``` -{/* set_default_beta-4_command:example:end */} -You will get the following output indicating that you have successfully set `beta-4` as your default toolchain. +{/*set_default_beta-4_command:example:end*/} + +You will get the following output indicating that you have successfully set `beta-4` as your default toolchain. ```console default toolchain set to 'beta-4' @@ -209,7 +221,7 @@ Now you are ready to start building with Fuel. ### Custom toolchains -You can create your own set of specific versions, this is known as 'custom toolchains'. +You can create your own set of specific versions, this is known as 'custom toolchains'. > 👉 Visit the [Fuelup docs](docs/fuelup/concepts/toolchains) to learn how to set up your own custom toolchains. @@ -221,6 +233,6 @@ You can always build the Fuel packages from source. ### Github Codespaces -It's always possible to run a development environment in the browser. +It's always possible to run a development environment in the browser. -> 👉 Please visit our guide on [Github Codespaces](guides/installation/codespace) to use the Fuel toolchain in the browser. \ No newline at end of file +> 👉 Please visit our guide on [Github Codespaces](guides/installation/codespace) to use the Fuel toolchain in the browser. diff --git a/docs/guides/docs/quickstart/building-a-frontend.mdx b/docs/guides/docs/quickstart/building-a-frontend.mdx index 7cd267052..52cba5f2f 100644 --- a/docs/guides/docs/quickstart/building-a-frontend.mdx +++ b/docs/guides/docs/quickstart/building-a-frontend.mdx @@ -41,7 +41,7 @@ Now, initialize a react project using [`Create React App`](https://create-react- @@ -83,7 +83,7 @@ Install `fuels` and `@fuel-wallet/sdk`. @@ -102,8 +102,8 @@ Next, update the TypeScript configuration at `tsconfig.json` to add the Fuel Wal @@ -162,7 +162,7 @@ File: `./frontend/src/App.tsx` @@ -177,7 +177,7 @@ Finally, replace the value of the `CONTRACT_ID` variable at the top of your `App ' --name 'react-dapp' --cwd ./guides-testing/fuel-project/frontend" }} /> @@ -239,7 +239,7 @@ Get help from the team by posting your question in the [Fuel Forum](https://foru @@ -247,7 +247,7 @@ action={{ @@ -255,7 +255,7 @@ action={{ @@ -279,7 +279,7 @@ action={{ @@ -312,14 +312,14 @@ action={{ @@ -327,7 +327,7 @@ action={{ \ No newline at end of file +/> diff --git a/docs/guides/docs/quickstart/building-a-smart-contract.mdx b/docs/guides/docs/quickstart/building-a-smart-contract.mdx index 74e8e234f..3f30064eb 100644 --- a/docs/guides/docs/quickstart/building-a-smart-contract.mdx +++ b/docs/guides/docs/quickstart/building-a-smart-contract.mdx @@ -78,8 +78,8 @@ We'll build a simple counter contract with two functions: one to increment the c @@ -101,7 +101,7 @@ Then create a contract project using `forc`: @@ -129,14 +129,14 @@ Report Bugs: - Sway Issues: https://github.com/FuelLabs/sway/issues/new ``` -{/* This example should include a tree for a new `forc` project and explain the boilerplate files */} -{/* forc_new:example:start */} +{/*This example should include a tree for a new `forc` project and explain the boilerplate files*/} +{/*forc_new:example:start*/} Here is the project that `forc` has initialized: @@ -151,8 +151,8 @@ counter-contract 1 directory, 2 files ``` -`forc.toml` is the _manifest file_ (similar to `Cargo.toml` for Cargo or `package.json` for Node) and defines project metadata such as the project name and dependencies. -{/* forc_new:example:end */} +`forc.toml` is the *manifest file* (similar to `Cargo.toml` for Cargo or `package.json` for Node) and defines project metadata such as the project name and dependencies. +{/*forc_new:example:end*/} Open your project in a code editor and delete everything in `src/main.sw` apart from the first line. @@ -217,7 +217,7 @@ Below your ABI definition, you will write the implementation of the functions de @@ -289,7 +289,7 @@ Let's have a look at the content of the `counter-contract` folder after building @@ -334,7 +334,7 @@ Now, let's generate the default test harness with the following: @@ -357,7 +357,7 @@ Let's have a look at the result: @@ -395,7 +395,7 @@ id="test-harness" action={{ name: 'modifyFile', filepath: 'guides-testing/fuel-project/counter-contract/tests/harness.rs', - addSpacesBefore: 1, + addSpacesBefore: 1, }} /> @@ -503,7 +503,7 @@ Just below the list, you'll see this prompt: Then you'll enter the number of the account of preference and press `Y` when prompted to accept the transaction. -Finally, you will get back the network endpoint where the contract was deployed, a `Contract ID` and the block where the transaction was signed. +Finally, you will get back the network endpoint where the contract was deployed, a `Contract ID` and the block where the transaction was signed. Save the `Contract ID`, as you'll need this later to connect the frontend. With this ID, you can also head to the [block explorer](https://fuellabs.github.io/block-explorer-v2/) to confirm the contract was deployed. diff --git a/docs/guides/docs/running-a-node/index.mdx b/docs/guides/docs/running-a-node/index.mdx index bb57fbc41..ec9df9cd6 100644 --- a/docs/guides/docs/running-a-node/index.mdx +++ b/docs/guides/docs/running-a-node/index.mdx @@ -11,6 +11,7 @@ parent: This guide is designed to swiftly introduce you to the process of running a local node for the Fuel blockchain. ## What is a Node? + In the context of the Fuel blockchain, a node, often referred to as a 'client', is a piece of software that downloads and maintains a copy of the Fuel blockchain. It verifies the authenticity of every block and transaction, ensuring that your copy is always up-to-date and in sync with the network. For the latest version of the Fuel client, please visit [here](https://github.com/FuelLabs/fuel-core). @@ -30,9 +31,9 @@ Running your own node provides several advantages: 1. **Query Freedom:** By hosting your own node, you can execute a higher number of queries without encountering any rate limits. 2. **Network Independence:** Having your own node ensures that you're not reliant on third-party services, giving you full control over your interactions with the Fuel blockchain. - ## Getting Started + Depending on your requirements, you can opt for one of the following setups: 1. [Run a Local Fuel Network Node:](./running-a-local-node/) This setup allows you to run a node that operates solely on your local environment. -2. [Connect to the Beta 4 Fuel Network:](./running-a-beta-4-node/) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. \ No newline at end of file +2. [Connect to the Beta 4 Fuel Network:](./running-a-beta-4-node/) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. diff --git a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx index 7e625d955..1c3798ca3 100644 --- a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx +++ b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx @@ -10,15 +10,15 @@ parent: ## Installation -{/* This example should include the instructions for installing Rust & Fuelup */} -{/* installation:example:start */} +{/*This example should include the instructions for installing Rust & Fuelup*/} +{/*installation:example:start*/} Start by [installing the Rust toolchain](https://www.rust-lang.org/tools/install). Then, [install the Fuel toolchain](/docs/fuelup/installation). -{/* installation:example:end */} +{/*installation:example:end*/} -{/* This example should include the instructions for installing the latest toolchain */} -{/* toolchain_installation:example:start */} +{/*This example should include the instructions for installing the latest toolchain*/} +{/*toolchain_installation:example:start*/} Make sure you have the latest version of `fuelup` by running the following command: ```console @@ -37,21 +37,28 @@ default toolchain set to 'beta-4-aarch64-apple-darwin' You can check your current toolchain anytime by running `fuelup show` to ensure you have `fuel-core 0.20.4`. ## Getting a Sepolia (Ethereum Testnet) API Key -An API key from any RPC provider that supports the Sepolia network will work. Relayers will help listen to events from the Ethereum network. We recommend either [Infura](https://www.infura.io/) or [Alchemy](https://www.alchemy.com/) + +An API key from any RPC provider that supports the Sepolia network will work. Relayers will help listen to events from the Ethereum network. We recommend either [Infura](https://www.infura.io/) or [Alchemy](https://www.alchemy.com/) The endpoints should look like the following + ### Infura + ```sh https://sepolia.infura.io/v3/{YOUR_API_KEY} ``` + ### Alchemy + ```sh https://eth-sepolia.g.alchemy.com/v2/{YOUR_API_KEY} ``` + Note that using other network endpoints will result in the relayer failing to start. ## Generating a P2P Key -Generate a new P2P key pairing by running the following command: + +Generate a new P2P key pairing by running the following command: ```sh $ fuel-core-keygen new --key-type peering @@ -62,7 +69,7 @@ $ fuel-core-keygen new --key-type peering } ``` -Make sure you save this somewhere safe so you don't need to generate a new key pair in the future. +Make sure you save this somewhere safe so you don't need to generate a new key pair in the future. ## Chain Configuration @@ -315,4 +322,3 @@ To connect to the local node using a browser wallet, import the network address ```sh http://127.0.0.1:4000/graphql ``` - diff --git a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx index ee06669e7..06685f439 100644 --- a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx +++ b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx @@ -67,7 +67,7 @@ Please follow the instructions provided below: - Clicking on Load unpacked and selecting the file. 7. If all goes right, an onboarding page will instantly open. -## Sway +## Sway Integer types no longer implicitly cast to each other. Here are some examples of the changes: @@ -187,7 +187,7 @@ request.addResources(resources); ``` Similarly, `addPredicateResourcesInputsAndOutputs` is now more concisely known as `addPredicateResources`. -The reason we have a distinct method for adding predicate resources is that the creation of predicate inputs mandates the presence of both the predicate’s bytes and data bytes. +The reason we have a distinct method for adding predicate resources is that the creation of predicate inputs mandates the presence of both the predicate’s bytes and data bytes. With these methods, there’s no longer a need to manually create and set up an instance of a `ScriptTransactionRequest`, simplifying the process further. ```typescript @@ -229,7 +229,7 @@ let response = contract_methods .await?; ``` -`setup_contract_test` has been changed to `setup_program_test`. +`setup_contract_test` has been changed to `setup_program_test`. The command to generate bindings with Abigen has been modified; previously, it was `Abigen(name="...")`, but now it requires the program type and should be written as `Abigen(Program_Type(name="..."))`: diff --git a/docs/guides/docs/testnet-migration/index.mdx b/docs/guides/docs/testnet-migration/index.mdx index 8eca8b439..392c3399b 100644 --- a/docs/guides/docs/testnet-migration/index.mdx +++ b/docs/guides/docs/testnet-migration/index.mdx @@ -19,7 +19,7 @@ This guide focuses SOLEY on addressing breaking changes across different testnet - [Typescript SDK](https://github.com/FuelLabs/fuels-ts/releases) - [Rust SDK](https://github.com/FuelLabs/fuels-rs/releases) -## Getting started +## Getting started Identify the specific testnet you are currently working on and follow the appropriate migration steps. diff --git a/mlc.json b/mlc.json new file mode 100644 index 000000000..025f01978 --- /dev/null +++ b/mlc.json @@ -0,0 +1,20 @@ +{ + "aliveStatusCodes": [200, 206, 405], + "ignorePatterns": [ + { + "pattern": "localhost:" + }, + { + "pattern": "^http://[1-9]" + }, + { + "pattern": "crates\\.io" + }, + { + "pattern": "-indexer.fuel.network" + }, + { + "pattern": "fuellabs.github.io/block-explorer-v2" + } + ] +} diff --git a/package.json b/package.json index b9fd7f540..43240e408 100644 --- a/package.json +++ b/package.json @@ -60,6 +60,7 @@ "hast-util-to-string": "^2.0.0", "hast-util-to-text": "^3.1.2", "hastscript": "^7.2.0", + "markdownlint-cli": "0.32.1", "next": "13.4.19", "next-contentlayer": "^0.3.4", "node-html-markdown": "^1.3.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f4d615719..e4c0c6bbd 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -109,6 +109,9 @@ dependencies: hastscript: specifier: ^7.2.0 version: 7.2.0 + markdownlint-cli: + specifier: 0.32.1 + version: 0.32.1 next: specifier: 13.4.19 version: 13.4.19(@opentelemetry/api@1.4.1)(react-dom@18.2.0)(react@18.2.0) @@ -5489,6 +5492,11 @@ packages: engines: {node: '>= 10'} dev: false + /commander@9.4.1: + resolution: {integrity: sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==} + engines: {node: ^12.20.0 || >=14} + dev: false + /commander@9.5.0: resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} engines: {node: ^12.20.0 || >=14} @@ -5717,7 +5725,6 @@ packages: /deep-extend@0.6.0: resolution: {integrity: sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==} engines: {node: '>=4.0.0'} - dev: true /deep-is@0.1.4: resolution: {integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==} @@ -5912,6 +5919,11 @@ packages: ansi-colors: 4.1.3 dev: false + /entities@3.0.1: + resolution: {integrity: sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==} + engines: {node: '>=0.12'} + dev: false + /entities@4.5.0: resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} engines: {node: '>=0.12'} @@ -6797,6 +6809,11 @@ packages: engines: {node: '>=6'} dev: false + /get-stdin@9.0.0: + resolution: {integrity: sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA==} + engines: {node: '>=12'} + dev: false + /get-stream@6.0.1: resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} engines: {node: '>=10'} @@ -6898,6 +6915,17 @@ packages: once: 1.4.0 path-is-absolute: 1.0.1 + /glob@8.0.3: + resolution: {integrity: sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==} + engines: {node: '>=12'} + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 5.1.6 + once: 1.4.0 + dev: false + /globals@13.21.0: resolution: {integrity: sha512-ybyme3s4yy/t/3s35bewwXKOf7cvzfreG2lH0lZl0JB7I4GxRP2ghxOK/Nb9EkRXdbBXZLfq/p/0W2JUONB/Gg==} engines: {node: '>=8'} @@ -7300,6 +7328,11 @@ packages: /ini@1.3.8: resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} + /ini@3.0.1: + resolution: {integrity: sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==} + engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + dev: false + /inline-style-parser@0.1.1: resolution: {integrity: sha512-7NXolsK4CAS5+xvdj5OMMbI962hU/wvwoxk+LWR9Ek9bVtyuuYScDN6eS0rUm6TxApFpw7CX1o4uJzcd4AyD3Q==} dev: false @@ -7689,6 +7722,10 @@ packages: minimist: 1.2.8 dev: false + /jsonc-parser@3.1.0: + resolution: {integrity: sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==} + dev: false + /jsonc-parser@3.2.0: resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} dev: false @@ -7751,6 +7788,12 @@ packages: engines: {node: '>=10'} dev: true + /linkify-it@4.0.1: + resolution: {integrity: sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==} + dependencies: + uc.micro: 1.0.6 + dev: false + /lint-staged@14.0.1: resolution: {integrity: sha512-Mw0cL6HXnHN1ag0mN/Dg4g6sr8uf8sn98w2Oc1ECtFto9tvRF7nkXGJRbx8gPlHyoR0pLyBr2lQHbWwmUHe1Sw==} engines: {node: ^16.14.0 || >=18.0.0} @@ -7886,10 +7929,50 @@ packages: engines: {node: '>=0.10.0'} dev: false + /markdown-it@13.0.1: + resolution: {integrity: sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==} + hasBin: true + dependencies: + argparse: 2.0.1 + entities: 3.0.1 + linkify-it: 4.0.1 + mdurl: 1.0.1 + uc.micro: 1.0.6 + dev: false + /markdown-table@3.0.3: resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} dev: false + /markdownlint-cli@0.32.1: + resolution: {integrity: sha512-hVLQ+72b5esQd7I+IqzBEB4x/4C+wJaxS2M6nqaGoDwrtNY6gydGf5CIUJtQcXtqsM615++a8TZPsvEtH6H4gw==} + engines: {node: '>=14'} + hasBin: true + dependencies: + commander: 9.4.1 + get-stdin: 9.0.0 + glob: 8.0.3 + ignore: 5.2.4 + js-yaml: 4.1.0 + jsonc-parser: 3.1.0 + markdownlint: 0.26.2 + markdownlint-rule-helpers: 0.17.2 + minimatch: 5.1.6 + run-con: 1.2.12 + dev: false + + /markdownlint-rule-helpers@0.17.2: + resolution: {integrity: sha512-XaeoW2NYSlWxMCZM2B3H7YTG6nlaLfkEZWMBhr4hSPlq9MuY2sy83+Xr89jXOqZMZYjvi5nBCGoFh7hHoPKZmA==} + engines: {node: '>=12'} + dev: false + + /markdownlint@0.26.2: + resolution: {integrity: sha512-2Am42YX2Ex5SQhRq35HxYWDfz1NLEOZWWN25nqd2h3AHRKsGRE+Qg1gt1++exW792eXTrR4jCNHfShfWk9Nz8w==} + engines: {node: '>=14'} + dependencies: + markdown-it: 13.0.1 + dev: false + /mdast-util-definitions@5.1.2: resolution: {integrity: sha512-8SVPMuHqlPME/z3gqVwWY4zVXn8lqKv/pAhC57FuJ40ImXyBpmO5ukh98zB2v7Blql2FiHjHv9LVztSIqjY+MA==} dependencies: @@ -8092,6 +8175,10 @@ packages: resolution: {integrity: sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==} dev: false + /mdurl@1.0.1: + resolution: {integrity: sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==} + dev: false + /mdx-bundler@9.2.1(esbuild@0.19.2): resolution: {integrity: sha512-hWEEip1KU9MCNqeH2rqwzAZ1pdqPPbfkx9OTJjADqGPQz4t9BO85fhI7AP9gVYrpmfArf9/xJZUN0yBErg/G/Q==} engines: {node: '>=14', npm: '>=6'} @@ -8525,6 +8612,13 @@ packages: dependencies: brace-expansion: 1.1.11 + /minimatch@5.1.6: + resolution: {integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==} + engines: {node: '>=10'} + dependencies: + brace-expansion: 2.0.1 + dev: false + /minimatch@9.0.3: resolution: {integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==} engines: {node: '>=16 || 14 >=14.17'} @@ -9838,6 +9932,16 @@ packages: execa: 5.1.1 dev: false + /run-con@1.2.12: + resolution: {integrity: sha512-5257ILMYIF4RztL9uoZ7V9Q97zHtNHn5bN3NobeAnzB1P3ASLgg8qocM2u+R18ttp+VEM78N2LK8XcNVtnSRrg==} + hasBin: true + dependencies: + deep-extend: 0.6.0 + ini: 3.0.1 + minimist: 1.2.8 + strip-json-comments: 3.1.1 + dev: false + /run-parallel@1.2.0: resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} dependencies: @@ -10549,6 +10653,10 @@ packages: engines: {node: '>=14.17'} hasBin: true + /uc.micro@1.0.6: + resolution: {integrity: sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==} + dev: false + /uglify-js@3.17.4: resolution: {integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==} engines: {node: '>=0.8.0'} From 2b2a34180f06d1181ac7a52c0af5f8d521e8e588 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Wed, 18 Oct 2023 15:04:51 -0600 Subject: [PATCH 02/22] fix --- .markdownlint.yaml | 2 + docs/guides/docs/installation/codespace.mdx | 18 ++--- package.json | 2 +- pnpm-lock.yaml | 76 +++++++-------------- 4 files changed, 36 insertions(+), 62 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 59d597fb1..b780b0f37 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,3 +1,5 @@ 'default': true # Default state for all rules 'MD013': false # Disable rule for line length 'MD033': false # Disable rule banning inline HTML +'MD034': false # Disable rule banning bare urls +'MD025': { 'front_matter_title': '' } # Without this, the title and h1 are considered two h1s diff --git a/docs/guides/docs/installation/codespace.mdx b/docs/guides/docs/installation/codespace.mdx index 8b92086b8..3b9c7f80d 100644 --- a/docs/guides/docs/installation/codespace.mdx +++ b/docs/guides/docs/installation/codespace.mdx @@ -8,17 +8,17 @@ parent: # Github Codespace -### Introduction +## Introduction The way to think about [Github Codespaces](https://github.com/features/codespaces) is essentially VSCode in a browser. It’s a remote development environment that is extremely easy to spin up. While not all VS Code plugins are supported, the Sway LSP plugin is supported and works out of the box. -### How to set up for a new repo +## How to set up for a new repo 1. Create a devcontainer.json file. The easiest way is by navigating to the repo and clicking Code → … → Configure dev container - -![dev container walkthrough](/images/dev-container.gif) - + + ![dev container walkthrough](/images/dev-container.gif) + 2. Edit the file to include the following features: @@ -47,14 +47,14 @@ The way to think about [Github Codespaces](https://github.com/features/codespace 3.2. [https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json](https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json) -### How to start a codespace +## How to start a codespace 1. Navigate to the repo that has Github Codespaces configured. 2. Choose Code → Create codespace on master - -![Create codespace walkthrough](/images/create-codespace.gif) - + + ![Create codespace walkthrough](/images/create-codespace.gif) + 3. This will open a new tab with your codespace. It can take several minutes to start up. diff --git a/package.json b/package.json index 43240e408..03dbbb542 100644 --- a/package.json +++ b/package.json @@ -60,7 +60,7 @@ "hast-util-to-string": "^2.0.0", "hast-util-to-text": "^3.1.2", "hastscript": "^7.2.0", - "markdownlint-cli": "0.32.1", + "markdownlint-cli": "^0.37.0", "next": "13.4.19", "next-contentlayer": "^0.3.4", "node-html-markdown": "^1.3.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e4c0c6bbd..6cce30d1a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -110,8 +110,8 @@ dependencies: specifier: ^7.2.0 version: 7.2.0 markdownlint-cli: - specifier: 0.32.1 - version: 0.32.1 + specifier: ^0.37.0 + version: 0.37.0 next: specifier: 13.4.19 version: 13.4.19(@opentelemetry/api@1.4.1)(react-dom@18.2.0)(react@18.2.0) @@ -5481,7 +5481,6 @@ packages: /commander@11.0.0: resolution: {integrity: sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==} engines: {node: '>=16'} - dev: true /commander@2.15.1: resolution: {integrity: sha512-VlfT9F3V0v+jr4yxPc5gg9s62/fIVWsd2Bk2iD435um1NlGMYdVCq+MjcXnhYq2icNOizHr1kK+5TI6H0Hy0ag==} @@ -5492,11 +5491,6 @@ packages: engines: {node: '>= 10'} dev: false - /commander@9.4.1: - resolution: {integrity: sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==} - engines: {node: ^12.20.0 || >=14} - dev: false - /commander@9.5.0: resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} engines: {node: ^12.20.0 || >=14} @@ -6915,17 +6909,6 @@ packages: once: 1.4.0 path-is-absolute: 1.0.1 - /glob@8.0.3: - resolution: {integrity: sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==} - engines: {node: '>=12'} - dependencies: - fs.realpath: 1.0.0 - inflight: 1.0.6 - inherits: 2.0.4 - minimatch: 5.1.6 - once: 1.4.0 - dev: false - /globals@13.21.0: resolution: {integrity: sha512-ybyme3s4yy/t/3s35bewwXKOf7cvzfreG2lH0lZl0JB7I4GxRP2ghxOK/Nb9EkRXdbBXZLfq/p/0W2JUONB/Gg==} engines: {node: '>=8'} @@ -7328,9 +7311,9 @@ packages: /ini@1.3.8: resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} - /ini@3.0.1: - resolution: {integrity: sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==} - engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + /ini@4.1.1: + resolution: {integrity: sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==} + engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0} dev: false /inline-style-parser@0.1.1: @@ -7722,10 +7705,6 @@ packages: minimist: 1.2.8 dev: false - /jsonc-parser@3.1.0: - resolution: {integrity: sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==} - dev: false - /jsonc-parser@3.2.0: resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} dev: false @@ -7944,33 +7923,33 @@ packages: resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} dev: false - /markdownlint-cli@0.32.1: - resolution: {integrity: sha512-hVLQ+72b5esQd7I+IqzBEB4x/4C+wJaxS2M6nqaGoDwrtNY6gydGf5CIUJtQcXtqsM615++a8TZPsvEtH6H4gw==} - engines: {node: '>=14'} + /markdownlint-cli@0.37.0: + resolution: {integrity: sha512-hNKAc0bWBBuVhJbSWbUhRzavstiB4o1jh3JeSpwC4/dt6eJ54lRfYHRxVdzVp4qGWBKbeE6Pg490PFEfrKjqSg==} + engines: {node: '>=16'} hasBin: true dependencies: - commander: 9.4.1 + commander: 11.0.0 get-stdin: 9.0.0 - glob: 8.0.3 + glob: 10.3.4 ignore: 5.2.4 js-yaml: 4.1.0 - jsonc-parser: 3.1.0 - markdownlint: 0.26.2 - markdownlint-rule-helpers: 0.17.2 - minimatch: 5.1.6 - run-con: 1.2.12 + jsonc-parser: 3.2.0 + markdownlint: 0.31.1 + minimatch: 9.0.3 + run-con: 1.3.2 dev: false - /markdownlint-rule-helpers@0.17.2: - resolution: {integrity: sha512-XaeoW2NYSlWxMCZM2B3H7YTG6nlaLfkEZWMBhr4hSPlq9MuY2sy83+Xr89jXOqZMZYjvi5nBCGoFh7hHoPKZmA==} - engines: {node: '>=12'} + /markdownlint-micromark@0.1.7: + resolution: {integrity: sha512-BbRPTC72fl5vlSKv37v/xIENSRDYL/7X/XoFzZ740FGEbs9vZerLrIkFRY0rv7slQKxDczToYuMmqQFN61fi4Q==} + engines: {node: '>=16'} dev: false - /markdownlint@0.26.2: - resolution: {integrity: sha512-2Am42YX2Ex5SQhRq35HxYWDfz1NLEOZWWN25nqd2h3AHRKsGRE+Qg1gt1++exW792eXTrR4jCNHfShfWk9Nz8w==} - engines: {node: '>=14'} + /markdownlint@0.31.1: + resolution: {integrity: sha512-CKMR2hgcIBrYlIUccDCOvi966PZ0kJExDrUi1R+oF9PvqQmCrTqjOsgIvf2403OmJ+CWomuzDoylr6KbuMyvHA==} + engines: {node: '>=16'} dependencies: markdown-it: 13.0.1 + markdownlint-micromark: 0.1.7 dev: false /mdast-util-definitions@5.1.2: @@ -8612,13 +8591,6 @@ packages: dependencies: brace-expansion: 1.1.11 - /minimatch@5.1.6: - resolution: {integrity: sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==} - engines: {node: '>=10'} - dependencies: - brace-expansion: 2.0.1 - dev: false - /minimatch@9.0.3: resolution: {integrity: sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==} engines: {node: '>=16 || 14 >=14.17'} @@ -9932,12 +9904,12 @@ packages: execa: 5.1.1 dev: false - /run-con@1.2.12: - resolution: {integrity: sha512-5257ILMYIF4RztL9uoZ7V9Q97zHtNHn5bN3NobeAnzB1P3ASLgg8qocM2u+R18ttp+VEM78N2LK8XcNVtnSRrg==} + /run-con@1.3.2: + resolution: {integrity: sha512-CcfE+mYiTcKEzg0IqS08+efdnH0oJ3zV0wSUFBNrMHMuxCtXvBCLzCJHatwuXDcu/RlhjTziTo/a1ruQik6/Yg==} hasBin: true dependencies: deep-extend: 0.6.0 - ini: 3.0.1 + ini: 4.1.1 minimist: 1.2.8 strip-json-comments: 3.1.1 dev: false From 323c872cc0c6963655b552f52ccfd51a50f30094 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:13:41 -0600 Subject: [PATCH 03/22] fixes --- .github/workflows/guides.yml | 21 ++++++++++++++----- .../quickstart/building-a-smart-contract.mdx | 2 +- docs/guides/docs/running-a-node/index.mdx | 4 ++-- .../beta-3-to-beta-4-migration.mdx | 21 ++----------------- docs/guides/docs/testnet-migration/index.mdx | 2 +- mlc.json => mlc-config.json | 12 +++++++++++ 6 files changed, 34 insertions(+), 28 deletions(-) rename mlc.json => mlc-config.json (61%) diff --git a/.github/workflows/guides.yml b/.github/workflows/guides.yml index 2719a7f2d..556afa6c1 100644 --- a/.github/workflows/guides.yml +++ b/.github/workflows/guides.yml @@ -1,4 +1,4 @@ -name: Guides Tests +name: Guides on: pull_request: @@ -9,19 +9,30 @@ jobs: name: Lint & Check Links runs-on: ubuntu-latest steps: + # SETUP & INSTALL - name: Checkout repo uses: actions/checkout@v3 - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 - with: - config-file: 'mlc..json' - file-extension: 'mdx' - uses: ./.github/actions/setup-node with: install: false - name: Install dependencies run: pnpm install + # RUN LINT CHECK - name: Lint Check run: pnpm markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' + # START DOCS SERVER + - name: Run Docs Hub Server + run: | + pnpm pm2 start 'PORT=3030 BROWSER=none npm run dev' --name 'doc-links' + - name: Wait for 12 seconds + run: sleep 12 + # RUN LINK CHECK + - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 + with: + config-file: 'mlc-config.json' + file-extension: 'mdx' + use-verbose-mode: 'yes' + folder-path: docs/guides/docs ## QUICKSTART TEST quickstart-test: diff --git a/docs/guides/docs/quickstart/building-a-smart-contract.mdx b/docs/guides/docs/quickstart/building-a-smart-contract.mdx index 3f30064eb..c5910227a 100644 --- a/docs/guides/docs/quickstart/building-a-smart-contract.mdx +++ b/docs/guides/docs/quickstart/building-a-smart-contract.mdx @@ -66,7 +66,7 @@ parent: trim="true" /> -For more detailed instructions on installing `fuelup`, visit the [installation guide](guides/installation). +For more detailed instructions on installing `fuelup`, visit the [installation guide](/guides/installation). > Having problems with this part? Post your question on our forum [https://forum.fuel.network/](https://forum.fuel.network/). To help you as efficiently as possible, include the output of this command in your post: `fuelup show.` diff --git a/docs/guides/docs/running-a-node/index.mdx b/docs/guides/docs/running-a-node/index.mdx index ec9df9cd6..001c3350d 100644 --- a/docs/guides/docs/running-a-node/index.mdx +++ b/docs/guides/docs/running-a-node/index.mdx @@ -35,5 +35,5 @@ Running your own node provides several advantages: Depending on your requirements, you can opt for one of the following setups: -1. [Run a Local Fuel Network Node:](./running-a-local-node/) This setup allows you to run a node that operates solely on your local environment. -2. [Connect to the Beta 4 Fuel Network:](./running-a-beta-4-node/) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. +1. [Run a Local Fuel Network Node:](/guides/running-a-local-node) This setup allows you to run a node that operates solely on your local environment. +2. [Connect to the Beta 4 Fuel Network:](/guides/running-a-beta-4-node) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. diff --git a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx index 06685f439..f2a76e597 100644 --- a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx +++ b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx @@ -46,26 +46,9 @@ default toolchain set to 'beta-4-aarch64-apple-darwin' ## Wallet -Fuel Wallet version `0.11.0` is not compatible with beta 4. For compatibility with beta-4, please download the non-backwards compatible Fuel Wallet version `0.12.3`. +If you have already installed the Fuel Wallet extension, make sure the extension is up-to-date. -```sh -pnpm install @fuel-wallet@0.12.3 -``` - -We have already submitted the beta-4 compatible version to the Chrome Web Store, and it is currently under review. Once your users update to this version, they will no longer be able to interact with the contracts you currently have deployed on the beta-3 testnet. - -Please follow the instructions provided below: - -1. Download [FuelWallet zip file](https://next-wallet.fuel.network/app/fuel-wallet.zip) -2. Inside Chrome or Brave; -3. Open the extensions page; it can be done by: - - Clicking on settings -> extensions or; -4. Accessing brave://extensions/ or chrome://extensions/. -5. Enable the "Developer mode" switch on the top right -6. Load fuel-wallet.zip by: - - Dragging your downloaded Fuel wallet file and dropping it in the extensions page or; - - Clicking on Load unpacked and selecting the file. -7. If all goes right, an onboarding page will instantly open. +If you haven't already installed the Fuel Wallet, you can install it [here](https://chrome.google.com/webstore/detail/fuel-wallet/dldjpboieedgcmpkchcjcbijingjcgok). ## Sway diff --git a/docs/guides/docs/testnet-migration/index.mdx b/docs/guides/docs/testnet-migration/index.mdx index 392c3399b..f58188d82 100644 --- a/docs/guides/docs/testnet-migration/index.mdx +++ b/docs/guides/docs/testnet-migration/index.mdx @@ -23,4 +23,4 @@ This guide focuses SOLEY on addressing breaking changes across different testnet Identify the specific testnet you are currently working on and follow the appropriate migration steps. -- [Beta 4 Migration Guide](./beta-3-to-beta-4-migration/) +- [Beta 4 Migration Guide](/guides/testnet-migration/beta-3-to-beta-4-migration) diff --git a/mlc.json b/mlc-config.json similarity index 61% rename from mlc.json rename to mlc-config.json index 025f01978..fe82c11a1 100644 --- a/mlc.json +++ b/mlc-config.json @@ -10,11 +10,23 @@ { "pattern": "crates\\.io" }, + { + "pattern": "infura\\.io" + }, + { + "pattern": "\\.zip$" + }, { "pattern": "-indexer.fuel.network" }, { "pattern": "fuellabs.github.io/block-explorer-v2" } + ], + "replacementPatterns": [ + { + "pattern": "^(/)(.*)", + "replacement": "http://localhost:3030/$2" + } ] } From 5d8cd5c34a517e3a52b2be086f87877d9abb5c9d Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Fri, 20 Oct 2023 08:50:17 -0600 Subject: [PATCH 04/22] fixes --- .github/workflows/guides.yml | 10 ++-------- docs/guides/docs/installation/index.mdx | 10 +++++----- docs/guides/docs/running-a-node/index.mdx | 4 ++-- mlc-config.json | 2 +- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/.github/workflows/guides.yml b/.github/workflows/guides.yml index 556afa6c1..305566dc9 100644 --- a/.github/workflows/guides.yml +++ b/.github/workflows/guides.yml @@ -16,16 +16,10 @@ jobs: with: install: false - name: Install dependencies - run: pnpm install + run: npm install -g markdownlint-cli@0.32.1 # RUN LINT CHECK - name: Lint Check - run: pnpm markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' - # START DOCS SERVER - - name: Run Docs Hub Server - run: | - pnpm pm2 start 'PORT=3030 BROWSER=none npm run dev' --name 'doc-links' - - name: Wait for 12 seconds - run: sleep 12 + run: markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' # RUN LINK CHECK - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 with: diff --git a/docs/guides/docs/installation/index.mdx b/docs/guides/docs/installation/index.mdx index de68c470a..779bd1d54 100644 --- a/docs/guides/docs/installation/index.mdx +++ b/docs/guides/docs/installation/index.mdx @@ -38,9 +38,9 @@ Check the official Rust documentation to get more information on [installing the `fuelup` is the official package manager for Fuel that installs the Fuel toolchain from the official release channels, enabling you to easily switch between different -toolchains and keep them updated. It makes building and maintaining Sway applications simpler with [`forc`](docs/forc) and [`fuel-core`](https://github.com/FuelLabs/fuel-core) for common platforms. +toolchains and keep them updated. It makes building and maintaining Sway applications simpler with [`forc`](/docs/forc) and [`fuel-core`](https://github.com/FuelLabs/fuel-core) for common platforms. -> 💡 Check out the [fuelup docs](docs/fuelup) for more information. +> 💡 Check out the [fuelup docs](/docs/fuelup) for more information. ### Running fuelup-init @@ -223,16 +223,16 @@ Now you are ready to start building with Fuel. You can create your own set of specific versions, this is known as 'custom toolchains'. -> 👉 Visit the [Fuelup docs](docs/fuelup/concepts/toolchains) to learn how to set up your own custom toolchains. +> 👉 Visit the [Fuelup docs](/docs/fuelup/concepts/toolchains) to learn how to set up your own custom toolchains. ### Build form source You can always build the Fuel packages from source. -> 👉 Visit the [Fuelup docs](docs/fuelup/install/other) to get more details about other types of installation. +> 👉 Visit the [Fuelup docs](/docs/fuelup/installation/other) to get more details about other types of installation. ### Github Codespaces It's always possible to run a development environment in the browser. -> 👉 Please visit our guide on [Github Codespaces](guides/installation/codespace) to use the Fuel toolchain in the browser. +> 👉 Please visit our guide on [Github Codespaces](/guides/installation/codespace) to use the Fuel toolchain in the browser. diff --git a/docs/guides/docs/running-a-node/index.mdx b/docs/guides/docs/running-a-node/index.mdx index 001c3350d..56f512d5a 100644 --- a/docs/guides/docs/running-a-node/index.mdx +++ b/docs/guides/docs/running-a-node/index.mdx @@ -35,5 +35,5 @@ Running your own node provides several advantages: Depending on your requirements, you can opt for one of the following setups: -1. [Run a Local Fuel Network Node:](/guides/running-a-local-node) This setup allows you to run a node that operates solely on your local environment. -2. [Connect to the Beta 4 Fuel Network:](/guides/running-a-beta-4-node) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. +1. [Run a Local Fuel Network Node:](/guides/running-a-node/running-a-local-node) This setup allows you to run a node that operates solely on your local environment. +2. [Connect to the Beta 4 Fuel Network:](/guides/running-a-node/running-a-beta-4-node) With this setup, your local node will connect and sync with the beta4 version of the Fuel network. diff --git a/mlc-config.json b/mlc-config.json index fe82c11a1..5ded0fc17 100644 --- a/mlc-config.json +++ b/mlc-config.json @@ -26,7 +26,7 @@ "replacementPatterns": [ { "pattern": "^(/)(.*)", - "replacement": "http://localhost:3030/$2" + "replacement": "https://docs-hub-git-sarah-lint-fuel-labs.vercel.app/$2" } ] } From 311248da24cac124d21f587351445a38819a5bc6 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:51:22 -0600 Subject: [PATCH 05/22] split lint & link checks --- .github/workflows/guides.yml | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/workflows/guides.yml b/.github/workflows/guides.yml index 305566dc9..6d6ddb07f 100644 --- a/.github/workflows/guides.yml +++ b/.github/workflows/guides.yml @@ -4,9 +4,9 @@ on: pull_request: jobs: - ## CHECK LINKS & LINT - check-links-lint: - name: Lint & Check Links + ## CHECKS ALL GUIDES FOR LINTING + linter: + name: Linter runs-on: ubuntu-latest steps: # SETUP & INSTALL @@ -20,8 +20,22 @@ jobs: # RUN LINT CHECK - name: Lint Check run: markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' + + ## CHECKS ALL LINKS IN GUIDES + ## RUNS AFTER VERCEL LINK IS DEPLOYED + check-links: + name: Check Links + runs-on: ubuntu-latest + steps: + # SETUP & INSTALL + - name: Checkout repo + uses: actions/checkout@v3 + - uses: ./.github/actions/setup-node + with: + install: false + # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL # RUN LINK CHECK - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 + - uses: gaurav-nelson/github-action-markdown-link-check with: config-file: 'mlc-config.json' file-extension: 'mdx' From 8c166d67bc61958c848dd6ea464076ddf1e6cb35 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 09:54:40 -0600 Subject: [PATCH 06/22] refactor --- .github/workflows/guides.yml | 21 ------------------- .github/workflows/links.yml | 32 +++++++++++++++++++++++++++++ mlc-config.json | 2 +- scripts/generate-mlc-config.mjs | 12 +++++++++++ scripts/update-latest-submodules.sh | 3 --- 5 files changed, 45 insertions(+), 25 deletions(-) create mode 100644 .github/workflows/links.yml create mode 100644 scripts/generate-mlc-config.mjs delete mode 100644 scripts/update-latest-submodules.sh diff --git a/.github/workflows/guides.yml b/.github/workflows/guides.yml index 6d6ddb07f..d6411bb1d 100644 --- a/.github/workflows/guides.yml +++ b/.github/workflows/guides.yml @@ -21,27 +21,6 @@ jobs: - name: Lint Check run: markdownlint --config .markdownlint.yaml --ignore-path .markdownlintignore '**/*.mdx' - ## CHECKS ALL LINKS IN GUIDES - ## RUNS AFTER VERCEL LINK IS DEPLOYED - check-links: - name: Check Links - runs-on: ubuntu-latest - steps: - # SETUP & INSTALL - - name: Checkout repo - uses: actions/checkout@v3 - - uses: ./.github/actions/setup-node - with: - install: false - # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL - # RUN LINK CHECK - - uses: gaurav-nelson/github-action-markdown-link-check - with: - config-file: 'mlc-config.json' - file-extension: 'mdx' - use-verbose-mode: 'yes' - folder-path: docs/guides/docs - ## QUICKSTART TEST quickstart-test: timeout-minutes: 30 diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 000000000..e1cf3ed59 --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,32 @@ +name: Links + +on: + workflow_run: + workflows: [Vercel] + types: + - completed + +jobs: + ## CHECKS ALL LINKS IN GUIDES + ## RUNS AFTER VERCEL LINK IS DEPLOYED + check-links: + name: Check Links + runs-on: ubuntu-latest + steps: + # SETUP & INSTALL + - name: Checkout repo + uses: actions/checkout@v3 + - uses: ./.github/actions/setup-node + with: + install: false + # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR + - name: Update preview link + run: node scripts/generate-mlc-config.mjs {{ github.head_ref }} + # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL + # RUN LINK CHECK + - uses: gaurav-nelson/github-action-markdown-link-check + with: + config-file: 'mlc-config.json' + file-extension: 'mdx' + # use-verbose-mode: 'yes' + folder-path: docs/guides/docs diff --git a/mlc-config.json b/mlc-config.json index 5ded0fc17..253f43afc 100644 --- a/mlc-config.json +++ b/mlc-config.json @@ -26,7 +26,7 @@ "replacementPatterns": [ { "pattern": "^(/)(.*)", - "replacement": "https://docs-hub-git-sarah-lint-fuel-labs.vercel.app/$2" + "replacement": "https://docs-hub-git-{{BRANCH}}-fuel-labs.vercel.app/$2" } ] } diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs new file mode 100644 index 000000000..a9c585b63 --- /dev/null +++ b/scripts/generate-mlc-config.mjs @@ -0,0 +1,12 @@ +import fs from 'fs'; + +main(); + +function main() { + const configPath = './mlc-config-test.json'; + const branchName = process.argv[2].replaceAll('/', '-').toLowerCase(); + console.log('BRANCH NAME:', branchName); + const configFile = fs.readFileSync(configPath, 'utf-8'); + const newContent = configFile.replace('{{BRANCH}}', branchName); + fs.writeFileSync(configPath, newContent); +} diff --git a/scripts/update-latest-submodules.sh b/scripts/update-latest-submodules.sh deleted file mode 100644 index 62428ab63..000000000 --- a/scripts/update-latest-submodules.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -git submodule update --remote docs/latest/sway docs/latest/builds/sway docs/latest/fuel-graphql-docs docs/latest/fuel-indexer docs/latest/fuel-specs docs/latest/fuels-rs docs/latest/fuels-ts docs/latest/fuels-wallet docs/latest/fuelup \ No newline at end of file From 5a5f8f59fb822989d16b8a689267cf78e9b8f918 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:32:20 -0600 Subject: [PATCH 07/22] fix --- .github/workflows/links.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index e1cf3ed59..0688db350 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -1,15 +1,13 @@ name: Links on: - workflow_run: - workflows: [Vercel] - types: - - completed + deployment_status: jobs: ## CHECKS ALL LINKS IN GUIDES ## RUNS AFTER VERCEL LINK IS DEPLOYED check-links: + if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' name: Check Links runs-on: ubuntu-latest steps: From 93d922afc25eecba011811cd4ceebbc56851d2a0 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:48:01 -0600 Subject: [PATCH 08/22] fix --- .github/workflows/links.yml | 14 ++++---------- mlc-config.json | 2 +- scripts/generate-mlc-config.mjs | 6 +++--- 3 files changed, 8 insertions(+), 14 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 0688db350..f8c2457af 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -1,25 +1,19 @@ name: Links on: - deployment_status: - + deployment_status: jobs: - ## CHECKS ALL LINKS IN GUIDES - ## RUNS AFTER VERCEL LINK IS DEPLOYED - check-links: + run-e2es: if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' - name: Check Links runs-on: ubuntu-latest steps: - # SETUP & INSTALL - - name: Checkout repo - uses: actions/checkout@v3 + - uses: actions/checkout@v3 - uses: ./.github/actions/setup-node with: install: false # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR - name: Update preview link - run: node scripts/generate-mlc-config.mjs {{ github.head_ref }} + run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.environment_url }} # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL # RUN LINK CHECK - uses: gaurav-nelson/github-action-markdown-link-check diff --git a/mlc-config.json b/mlc-config.json index 253f43afc..79e50f695 100644 --- a/mlc-config.json +++ b/mlc-config.json @@ -26,7 +26,7 @@ "replacementPatterns": [ { "pattern": "^(/)(.*)", - "replacement": "https://docs-hub-git-{{BRANCH}}-fuel-labs.vercel.app/$2" + "replacement": "{{VERCEL_PREVIEW}}$2" } ] } diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs index a9c585b63..e40e2e688 100644 --- a/scripts/generate-mlc-config.mjs +++ b/scripts/generate-mlc-config.mjs @@ -3,10 +3,10 @@ import fs from 'fs'; main(); function main() { + const previewURL = process.argv[2]; + console.log('PREVIEW URL:', previewURL); const configPath = './mlc-config-test.json'; - const branchName = process.argv[2].replaceAll('/', '-').toLowerCase(); - console.log('BRANCH NAME:', branchName); const configFile = fs.readFileSync(configPath, 'utf-8'); - const newContent = configFile.replace('{{BRANCH}}', branchName); + const newContent = configFile.replace('{{VERCEL_PREVIEW}}', previewURL); fs.writeFileSync(configPath, newContent); } From aeaa438751ee17ce30a4a70543847101cdbf0d70 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:48:52 -0600 Subject: [PATCH 09/22] rename --- .github/workflows/links.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index f8c2457af..ae0028289 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -3,7 +3,7 @@ name: Links on: deployment_status: jobs: - run-e2es: + check-links: if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' runs-on: ubuntu-latest steps: From 1fa917ba890cd2430fd206183626f136f76b9198 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:50:23 -0600 Subject: [PATCH 10/22] try fix --- .github/workflows/links.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index ae0028289..52ad0820e 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -7,7 +7,7 @@ jobs: if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v2 - uses: ./.github/actions/setup-node with: install: false From c92e645d730d41cc209aef5352c2001d3eb91fa7 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 10:50:51 -0600 Subject: [PATCH 11/22] try fix --- .github/workflows/links.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 52ad0820e..f8e9ec821 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -1,7 +1,7 @@ name: Links on: - deployment_status: + [deployment_status] jobs: check-links: if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' From 361bfdc926fd457463171df1a18ac7ad3376038d Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 11:01:08 -0600 Subject: [PATCH 12/22] fix --- .github/workflows/links.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index f8e9ec821..a1a6e157c 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -1,13 +1,14 @@ name: Links on: - [deployment_status] + deployment_status + jobs: check-links: - if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success' + if: github.event.deployment_status.state == 'success' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: ./.github/actions/setup-node with: install: false From 82acdbd1b00389cb757d52f2438137e6b6ec64e9 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 11:13:58 -0600 Subject: [PATCH 13/22] test --- .github/workflows/links.yml | 19 +++++++++---------- scripts/generate-mlc-config.mjs | 16 +++++++++------- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index a1a6e157c..c5764e5cd 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -5,7 +5,6 @@ on: jobs: check-links: - if: github.event.deployment_status.state == 'success' runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -14,12 +13,12 @@ jobs: install: false # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR - name: Update preview link - run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.environment_url }} - # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL - # RUN LINK CHECK - - uses: gaurav-nelson/github-action-markdown-link-check - with: - config-file: 'mlc-config.json' - file-extension: 'mdx' - # use-verbose-mode: 'yes' - folder-path: docs/guides/docs + run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.state }} ${{ github.event.deployment_status.environment_url }} + # # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL + # # RUN LINK CHECK + # - uses: gaurav-nelson/github-action-markdown-link-check + # with: + # config-file: 'mlc-config.json' + # file-extension: 'mdx' + # # use-verbose-mode: 'yes' + # folder-path: docs/guides/docs diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs index e40e2e688..7429dd5e4 100644 --- a/scripts/generate-mlc-config.mjs +++ b/scripts/generate-mlc-config.mjs @@ -1,12 +1,14 @@ -import fs from 'fs'; +// import fs from 'fs'; main(); function main() { - const previewURL = process.argv[2]; - console.log('PREVIEW URL:', previewURL); - const configPath = './mlc-config-test.json'; - const configFile = fs.readFileSync(configPath, 'utf-8'); - const newContent = configFile.replace('{{VERCEL_PREVIEW}}', previewURL); - fs.writeFileSync(configPath, newContent); + console.log('DEPLOYMENT STATE:', process.argv[2]); + console.log('DEPLOYMENT URL:', process.argv[3]); + // const previewURL = process.argv[2]; + // console.log('PREVIEW URL:', previewURL); + // const configPath = './mlc-config-test.json'; + // const configFile = fs.readFileSync(configPath, 'utf-8'); + // const newContent = configFile.replace('{{VERCEL_PREVIEW}}', previewURL); + // fs.writeFileSync(configPath, newContent); } From f8de6d3dcc07257bb3569f30dd369a8323ace80b Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 11:26:53 -0600 Subject: [PATCH 14/22] cleanup --- .github/workflows/links.yml | 16 ++++++++-------- mlc-config.json | 2 +- scripts/generate-mlc-config.mjs | 24 +++++++++++++++--------- 3 files changed, 24 insertions(+), 18 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index c5764e5cd..2300f2b6f 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -14,11 +14,11 @@ jobs: # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR - name: Update preview link run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.state }} ${{ github.event.deployment_status.environment_url }} - # # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL - # # RUN LINK CHECK - # - uses: gaurav-nelson/github-action-markdown-link-check - # with: - # config-file: 'mlc-config.json' - # file-extension: 'mdx' - # # use-verbose-mode: 'yes' - # folder-path: docs/guides/docs + # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL + # RUN LINK CHECK + - uses: gaurav-nelson/github-action-markdown-link-check + with: + config-file: 'mlc-config.json' + file-extension: 'mdx' + # use-verbose-mode: 'yes' + folder-path: docs/guides/docs diff --git a/mlc-config.json b/mlc-config.json index 79e50f695..28531f157 100644 --- a/mlc-config.json +++ b/mlc-config.json @@ -26,7 +26,7 @@ "replacementPatterns": [ { "pattern": "^(/)(.*)", - "replacement": "{{VERCEL_PREVIEW}}$2" + "replacement": "{{VERCEL_PREVIEW}}/$2" } ] } diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs index 7429dd5e4..344636c5f 100644 --- a/scripts/generate-mlc-config.mjs +++ b/scripts/generate-mlc-config.mjs @@ -1,14 +1,20 @@ -// import fs from 'fs'; +import fs from 'fs'; main(); +const configPath = './mlc-config-test.json'; + function main() { - console.log('DEPLOYMENT STATE:', process.argv[2]); - console.log('DEPLOYMENT URL:', process.argv[3]); - // const previewURL = process.argv[2]; - // console.log('PREVIEW URL:', previewURL); - // const configPath = './mlc-config-test.json'; - // const configFile = fs.readFileSync(configPath, 'utf-8'); - // const newContent = configFile.replace('{{VERCEL_PREVIEW}}', previewURL); - // fs.writeFileSync(configPath, newContent); + const deploymentState = process.argv[2]; + console.log('DEPLOYMENT STATE:', deploymentState); + const deploymentURL = process.argv[3]; + console.log('DEPLOYMENT URL:', deploymentURL); + + if (deploymentState === 'success' && deploymentURL) { + const configFile = fs.readFileSync(configPath, 'utf-8'); + const newContent = configFile.replace('{{VERCEL_PREVIEW}}', deploymentURL); + fs.writeFileSync(configPath, newContent); + } else { + throw Error('MISSING VERCEL DEPLOYMENT'); + } } From 6dc87e8213e4f5101862ee0191b516f58e7c6578 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 11:36:24 -0600 Subject: [PATCH 15/22] cleanup --- .github/workflows/links.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 2300f2b6f..334ab1559 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -14,11 +14,9 @@ jobs: # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR - name: Update preview link run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.state }} ${{ github.event.deployment_status.environment_url }} - # RUN SCRIPT TO GENERATE NEW CONFIG WITH VERCEL PREVIEW URL # RUN LINK CHECK - uses: gaurav-nelson/github-action-markdown-link-check with: config-file: 'mlc-config.json' file-extension: 'mdx' - # use-verbose-mode: 'yes' folder-path: docs/guides/docs From 503e057a5c15553907e783f01e47b03a6e838b35 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 12:32:16 -0600 Subject: [PATCH 16/22] fix --- .github/workflows/links.yml | 2 +- scripts/generate-mlc-config.mjs | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 334ab1559..d8f1180cc 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -15,7 +15,7 @@ jobs: - name: Update preview link run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.state }} ${{ github.event.deployment_status.environment_url }} # RUN LINK CHECK - - uses: gaurav-nelson/github-action-markdown-link-check + - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 with: config-file: 'mlc-config.json' file-extension: 'mdx' diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs index 344636c5f..c993c7377 100644 --- a/scripts/generate-mlc-config.mjs +++ b/scripts/generate-mlc-config.mjs @@ -2,8 +2,6 @@ import fs from 'fs'; main(); -const configPath = './mlc-config-test.json'; - function main() { const deploymentState = process.argv[2]; console.log('DEPLOYMENT STATE:', deploymentState); @@ -11,6 +9,7 @@ function main() { console.log('DEPLOYMENT URL:', deploymentURL); if (deploymentState === 'success' && deploymentURL) { + const configPath = './mlc-config.json'; const configFile = fs.readFileSync(configPath, 'utf-8'); const newContent = configFile.replace('{{VERCEL_PREVIEW}}', deploymentURL); fs.writeFileSync(configPath, newContent); From 23e9bf9d9877f32924422b26d8ff8fd809fa0aab Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 13:39:54 -0600 Subject: [PATCH 17/22] replace link check workflow --- .github/workflows/links.yml | 19 +++++-------------- mlc-config.json | 32 -------------------------------- scripts/generate-mlc-config.mjs | 19 ------------------- 3 files changed, 5 insertions(+), 65 deletions(-) delete mode 100644 mlc-config.json delete mode 100644 scripts/generate-mlc-config.mjs diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index d8f1180cc..24f420718 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -4,19 +4,10 @@ on: deployment_status jobs: - check-links: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: ./.github/actions/setup-node + check-links: + uses: FuelLabs/github-actions/.github/workflows/next-links.yml@sarah/next-links-check with: - install: false - # RUN SCRIPT TO USE VERCEL PREVIEW LINK FROM PR - - name: Update preview link - run: node scripts/generate-mlc-config.mjs ${{ github.event.deployment_status.state }} ${{ github.event.deployment_status.environment_url }} - # RUN LINK CHECK - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.12 - with: - config-file: 'mlc-config.json' - file-extension: 'mdx' + status: ${{ github.event.deployment_status.state }} + preview-url: ${{ github.event.deployment_status.environment_url }} folder-path: docs/guides/docs + diff --git a/mlc-config.json b/mlc-config.json deleted file mode 100644 index 28531f157..000000000 --- a/mlc-config.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "aliveStatusCodes": [200, 206, 405], - "ignorePatterns": [ - { - "pattern": "localhost:" - }, - { - "pattern": "^http://[1-9]" - }, - { - "pattern": "crates\\.io" - }, - { - "pattern": "infura\\.io" - }, - { - "pattern": "\\.zip$" - }, - { - "pattern": "-indexer.fuel.network" - }, - { - "pattern": "fuellabs.github.io/block-explorer-v2" - } - ], - "replacementPatterns": [ - { - "pattern": "^(/)(.*)", - "replacement": "{{VERCEL_PREVIEW}}/$2" - } - ] -} diff --git a/scripts/generate-mlc-config.mjs b/scripts/generate-mlc-config.mjs deleted file mode 100644 index c993c7377..000000000 --- a/scripts/generate-mlc-config.mjs +++ /dev/null @@ -1,19 +0,0 @@ -import fs from 'fs'; - -main(); - -function main() { - const deploymentState = process.argv[2]; - console.log('DEPLOYMENT STATE:', deploymentState); - const deploymentURL = process.argv[3]; - console.log('DEPLOYMENT URL:', deploymentURL); - - if (deploymentState === 'success' && deploymentURL) { - const configPath = './mlc-config.json'; - const configFile = fs.readFileSync(configPath, 'utf-8'); - const newContent = configFile.replace('{{VERCEL_PREVIEW}}', deploymentURL); - fs.writeFileSync(configPath, newContent); - } else { - throw Error('MISSING VERCEL DEPLOYMENT'); - } -} From 75829b7c81fdb5204b8662cb6a48e05495d1acea Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 13:54:00 -0600 Subject: [PATCH 18/22] remove space --- .github/workflows/links.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 24f420718..bae2af6ed 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -10,4 +10,3 @@ jobs: status: ${{ github.event.deployment_status.state }} preview-url: ${{ github.event.deployment_status.environment_url }} folder-path: docs/guides/docs - From f13f1e10fc908776301ccd906ff8d636f3575bf5 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 15:57:57 -0600 Subject: [PATCH 19/22] add spell check --- .github/workflows/guides.yml | 18 +++++- .spellcheck.yml | 21 +++++++ docs/guides/docs/installation/codespace.mdx | 8 +-- docs/guides/docs/installation/index.mdx | 6 +- .../docs/quickstart/building-a-frontend.mdx | 2 +- .../quickstart/building-a-smart-contract.mdx | 2 +- .../running-a-node/running-a-beta-4-node.mdx | 6 +- .../running-a-node/running-a-local-node.mdx | 10 ++-- .../beta-3-to-beta-4-migration.mdx | 2 +- docs/guides/docs/testnet-migration/index.mdx | 2 +- spell-check-custom-words.txt | 55 +++++++++++++++++++ 11 files changed, 109 insertions(+), 23 deletions(-) create mode 100644 .spellcheck.yml create mode 100644 spell-check-custom-words.txt diff --git a/.github/workflows/guides.yml b/.github/workflows/guides.yml index d6411bb1d..9deead06b 100644 --- a/.github/workflows/guides.yml +++ b/.github/workflows/guides.yml @@ -4,9 +4,21 @@ on: pull_request: jobs: - ## CHECKS ALL GUIDES FOR LINTING - linter: - name: Linter + ## SPELL CHECK ALL GUIDES + spell-check: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v3 + - uses: rojopolis/spellcheck-github-actions@0.34.0 + name: Spellcheck + with: + config_path: .spellcheck.yml + task_name: SPCheck + + ## LINT CHECK ALL GUIDES + lint: + name: Lint runs-on: ubuntu-latest steps: # SETUP & INSTALL diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 000000000..04d3d4d13 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,21 @@ +matrix: + - name: SPCheck + aspell: + lang: en + dictionary: + encoding: utf-8 + wordlists: + - ./spell-check-custom-words.txt + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - pymdownx.superfences + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + - TestAction + sources: + - '**/guides/docs/**/*.mdx' + default_encoding: utf-8 diff --git a/docs/guides/docs/installation/codespace.mdx b/docs/guides/docs/installation/codespace.mdx index 3b9c7f80d..f587c899a 100644 --- a/docs/guides/docs/installation/codespace.mdx +++ b/docs/guides/docs/installation/codespace.mdx @@ -14,7 +14,7 @@ The way to think about [Github Codespaces](https://github.com/features/codespace ## How to set up for a new repo -1. Create a devcontainer.json file. The easiest way is by navigating to the repo and clicking Code → … → Configure dev container +1. Create a `devcontainer.json` file. The easiest way is by navigating to the repo and clicking Code → … → Configure dev container ![dev container walkthrough](/images/dev-container.gif) @@ -43,9 +43,9 @@ The way to think about [Github Codespaces](https://github.com/features/codespace Here are examples that include the Sway LSP plugin. - 3.1. [https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json](https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json) + 3.1. [`https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json`](https://github.com/FuelLabs/sway/blob/master/.devcontainer/devcontainer.json) - 3.2. [https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json](https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json) + 3.2. [`https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json`](https://github.com/FuelLabs/quickstart/blob/master/.devcontainer/devcontainer.json) ## How to start a codespace @@ -58,7 +58,7 @@ The way to think about [Github Codespaces](https://github.com/features/codespace 3. This will open a new tab with your codespace. It can take several minutes to start up. - 3.1. You now have a fully functional remote dev environment with the Fuel toolchain installed! You can use `forc` to build and deploy Sway code, or `fuelup` to manage the toolchain version. You also have the Sway LSP plugin with full feature support for Sway, like syntax highlighting, hover docs, go-to definitions, etc. + 3.1. You now have a fully functional remote development environment with the Fuel toolchain installed! You can use `forc` to build and deploy Sway code, or `fuelup` to manage the toolchain version. You also have the Sway LSP plugin with full feature support for Sway, like syntax highlighting, hover docs, go-to definitions, etc. 3.2. Note: if you are working on a large repository and find the codespace is running slow, you can configure it to use a larger instance by clicking Code → … → change machine type on a running instance, or starting a new instance with Code → … → New with options. diff --git a/docs/guides/docs/installation/index.mdx b/docs/guides/docs/installation/index.mdx index 779bd1d54..d18a36015 100644 --- a/docs/guides/docs/installation/index.mdx +++ b/docs/guides/docs/installation/index.mdx @@ -22,7 +22,7 @@ This guide covers the following topics: The Fuel toolchain is built on top of the Rust programming language. To install Rust, you can use the `rustup` tool. {/*install_rust:example:end*/} -Run the following command in your shell; this downloads and runs rustup-init.sh, which in turn downloads and runs the correct version of the `rustup-init` executable for your platform. +Run the following command in your shell; this downloads and runs `rustup-init.sh`, which in turn downloads and runs the correct version of the `rustup-init` executable for your platform. {/*install_rust_command:example:start*/} @@ -42,7 +42,7 @@ toolchains and keep them updated. It makes building and maintaining Sway applica > 💡 Check out the [fuelup docs](/docs/fuelup) for more information. -### Running fuelup-init +### Running `fuelup-init` {/*install_fuelup:example:start*/} To install the Fuel toolchain, you'll use the `fuelup-init` script. This will install `forc`, `forc-client`, `forc-fmt`, `forc-lsp`, `forc-wallet` as well as `fuel-core` in `~/.fuelup/bin`. @@ -104,7 +104,7 @@ fuelup 0.19.5 ## Setting up a default toolchain -Just as in [Rust](https://rust-lang.github.io/rustup/concepts/toolchains.html), Fuel supports multiple toolchains. A toolchain is a collection of tools (such as the compiler, lsp, etc). +Just as in [Rust](https://rust-lang.github.io/rustup/concepts/toolchains.html), Fuel supports multiple toolchains. A toolchain is a collection of tools (such as the compiler, LSP, etc). By default, `fuelup` includes a series of packages tested to work with each other, providing a reliable set of tools. In this case, we will install the `beta-4` toolchain, which is the stable toolchain compatible with the beta-4 network. For more information on `beta-4` check the [Fuel blog](https://fuel-labs.ghost.io/announcing-beta-4-testnet/) page. diff --git a/docs/guides/docs/quickstart/building-a-frontend.mdx b/docs/guides/docs/quickstart/building-a-frontend.mdx index 52cba5f2f..b157cfc15 100644 --- a/docs/guides/docs/quickstart/building-a-frontend.mdx +++ b/docs/guides/docs/quickstart/building-a-frontend.mdx @@ -68,7 +68,7 @@ The `fuels` umbrella package includes all the main tools you need for your front Also, it contains the routines for ABI TypeScript generation. -> ABI stands for Application Binary Interface. ABI's inform the application the interface to interact with the VM, in other words, they provide info to the APP such as what methods a contract has, what params, types it expects, etc... +> ABI stands for Application Binary Interface. ABIs inform the application the interface to interact with the VM, in other words, they provide info to the APP such as what methods a contract has, what params, types it expects, etc... ### Installing diff --git a/docs/guides/docs/quickstart/building-a-smart-contract.mdx b/docs/guides/docs/quickstart/building-a-smart-contract.mdx index c5910227a..78d9e003d 100644 --- a/docs/guides/docs/quickstart/building-a-smart-contract.mdx +++ b/docs/guides/docs/quickstart/building-a-smart-contract.mdx @@ -68,7 +68,7 @@ parent: For more detailed instructions on installing `fuelup`, visit the [installation guide](/guides/installation). -> Having problems with this part? Post your question on our forum [https://forum.fuel.network/](https://forum.fuel.network/). To help you as efficiently as possible, include the output of this command in your post: `fuelup show.` +> Having problems with this part? Post your question on our [forum](https://forum.fuel.network/). To help you as efficiently as possible, include the output of this command in your post: `fuelup show.` ## Your First Sway Project diff --git a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx index 1c3798ca3..694f4a49b 100644 --- a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx +++ b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx @@ -73,7 +73,7 @@ Make sure you save this somewhere safe so you don't need to generate a new key p ## Chain Configuration -To run a local node with persistance, you must configure a `chainConfig.json` file. Here is the [specific configuration](https://github.com/FuelLabs/fuel-core/blob/v0.20.4/deployment/scripts/chainspec/beta_chainspec.json) for `beta-4`: +To run a local node with persistence, you must configure a `chainConfig.json` file. Here is the [specific configuration](https://github.com/FuelLabs/fuel-core/blob/v0.20.4/deployment/scripts/chainspec/beta_chainspec.json) for `beta-4`: ```json { @@ -287,9 +287,7 @@ To run a local node with persistance, you must configure a `chainConfig.json` fi Finally to put everything together to start the node, run the following command: -{/* -TODO Add `--enable-relayer` to list of arguments later -*/} +{/* TODO Add `--enable-relayer` to list of arguments later */} ```sh $ fuel-core run \ diff --git a/docs/guides/docs/running-a-node/running-a-local-node.mdx b/docs/guides/docs/running-a-node/running-a-local-node.mdx index ddaf38ed5..58f344754 100644 --- a/docs/guides/docs/running-a-node/running-a-local-node.mdx +++ b/docs/guides/docs/running-a-node/running-a-local-node.mdx @@ -12,10 +12,10 @@ In addition to deploying and testing on the Fuel Testnet, you can also run a loc There are two types of Fuel networks that can be run: -1. In-memory network (without persistance) -2. Local network with persistance +1. In-memory network (without persistence) +2. Local network with persistence -## In-memory local node (without state persistance) +## In-memory local node (without state persistence) An in-memory node does not persist the blockchain state anywhere, it is only stored in memory as long as the node is active and running. @@ -37,11 +37,11 @@ Or to deploy without using a signing key: forc deploy --unsigned --node-url 127.0.0.1:4000/graphql ``` -## Local node (with state persistance) +## Local node (with state persistence) This node does persist the blockchain state locally. -To run a local node with persistance, you must configure a `chainConfig.json` file. Here is an example of what that looks like: +To run a local node with persistence, you must configure a `chainConfig.json` file. Here is an example of what that looks like: ```json { diff --git a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx index f2a76e597..6f0d18726 100644 --- a/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx +++ b/docs/guides/docs/testnet-migration/beta-3-to-beta-4-migration.mdx @@ -234,7 +234,7 @@ setup_program_test!( ); ``` -Now supporting String types, there have been slight modifications if you directly use ParamTypes: +Now supporting String types, there have been slight modifications if you directly use `ParamTypes`: ```rust // BEFORE - BETA 3 diff --git a/docs/guides/docs/testnet-migration/index.mdx b/docs/guides/docs/testnet-migration/index.mdx index f58188d82..9c9e65562 100644 --- a/docs/guides/docs/testnet-migration/index.mdx +++ b/docs/guides/docs/testnet-migration/index.mdx @@ -12,7 +12,7 @@ Throughout Fuel's development journey, numerous testnets have been created to en ## Breaking Changes -This guide focuses SOLEY on addressing breaking changes across different testnets. For information on new features, please consult the respective release notes: +This guide focuses only on addressing breaking changes across different testnets. For information on new features, please consult the respective release notes: - [Fuelup installation](https://github.com/FuelLabs/fuelup/releases) - [Sway](https://github.com/FuelLabs/sway/releases) diff --git a/spell-check-custom-words.txt b/spell-check-custom-words.txt new file mode 100644 index 000000000..969b50375 --- /dev/null +++ b/spell-check-custom-words.txt @@ -0,0 +1,55 @@ +SDK +testnet +testnets +mainnet +config +JSON +abigen +blockchain +blockchain's +ABI +ABIs +ERC +Ethereum +Ethereum's +natively +toolchain +toolchains +relayer +relayers +Infura +RPC +Sepolia +PoA +PoS +PoW +validator +validators +codespace +codespaces +Github +quickstart +forc +bytecode +struct +Fuelup +fuelup +LSP +graphQL +GraphQL +repo +customizations +VSCode +frontend +dapp +fullstack +TypeScript +params +VM +FuelVM +FVM +stateful +runnable +CLI +dev +TODO \ No newline at end of file From fa8cfecfd4de613ea9643192d6c9df1dd242ff65 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:04:26 -0600 Subject: [PATCH 20/22] fix --- docs/guides/docs/running-a-node/running-a-beta-4-node.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx index 694f4a49b..8492538d8 100644 --- a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx +++ b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx @@ -287,7 +287,9 @@ To run a local node with persistence, you must configure a `chainConfig.json` fi Finally to put everything together to start the node, run the following command: -{/* TODO Add `--enable-relayer` to list of arguments later */} +{/* +TODO Add `--enable-relayer` to list of arguments later +*/} ```sh $ fuel-core run \ From c8d8705623ffd896b8b35e371a8c19cf9935f939 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:06:39 -0600 Subject: [PATCH 21/22] fix lint --- docs/guides/docs/running-a-node/running-a-beta-4-node.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx index 8492538d8..9ee721d57 100644 --- a/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx +++ b/docs/guides/docs/running-a-node/running-a-beta-4-node.mdx @@ -287,8 +287,8 @@ To run a local node with persistence, you must configure a `chainConfig.json` fi Finally to put everything together to start the node, run the following command: -{/* -TODO Add `--enable-relayer` to list of arguments later +{/* +TODO Add `--enable-relayer` to list of arguments later */} ```sh From 1e92edd8aea409272003f554d438b31df5e4a147 Mon Sep 17 00:00:00 2001 From: sarahschwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:23:30 -0600 Subject: [PATCH 22/22] change to master --- .github/workflows/links.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index bae2af6ed..cde883bf4 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -5,7 +5,7 @@ on: jobs: check-links: - uses: FuelLabs/github-actions/.github/workflows/next-links.yml@sarah/next-links-check + uses: FuelLabs/github-actions/.github/workflows/next-links.yml@master with: status: ${{ github.event.deployment_status.state }} preview-url: ${{ github.event.deployment_status.environment_url }}