Merge pull request #15 from webb-tools/lychee-linkcheck-update-and-fix

tangle-network · Jan 19, 2024 · 37e3197 · 37e3197
2 parents f5fc342 + b07f298
commit 37e3197
Show file tree

Hide file tree

Showing 23 changed files with 76 additions and 72 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -59,8 +59,9 @@ jobs:
           access_token: ${{ secrets.GITHUB_TOKEN }}
       - uses: actions/checkout@v3
       - name: Link Checker
-        uses: lycheeverse/lychee-action@v1.5.4
+        uses: lycheeverse/lychee-action@v1.9.0
         with:
+          args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.mdx'
           fail: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1,2 @@
+http://localhost*
+https://localhost*
diff --git a/components/NetworkConfig.tsx b/components/NetworkConfig.tsx
@@ -95,7 +95,7 @@ const NetworkInfo = () => {
       rpcUrl: "https://testnet-rpc.tangle.tools",
       wssUrl: "wss://testnet-rpc.tangle.tools",
       explorerUrls: [
-        { name: "BlockScout", url: "https://explorer.tangle.tools" },
+        { name: "BlockScout", url: "https://testnet-explorer.tangle.tools" },
         {
           name: "PolkadotJS",
           url: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer",

diff --git a/package.json b/package.json
@@ -8,7 +8,7 @@
     "start": "next start",
     "build": "next build",
     "export": "next export",
-    "lint": "next lint",
+    "lint": "next lint && yarn format",
     "schema": "turbo-gen ./public/schema.json",
     "format": "prettier --write \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" ",
     "format:check": "prettier --check \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" "

diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json
@@ -8,7 +8,7 @@
   "node": "Node",
   "governance": "Govern",
   "community": "Community",
-  "faqs": "FAQs",
+  "faq": "FAQ",
   "glossary": "Glossary",
   "contribute": "Contribute or Submit a Bug",
   "webb_docs_link": {

diff --git a/pages/docs/build/pallets/balances-and-accounts.mdx b/pages/docs/build/pallets/balances-and-accounts.mdx
@@ -37,4 +37,4 @@ The Balances pallet provides a versatile API that allows interaction from within
 - `unreserve`: Unreserve some funds, returning any amount that was unable to be unreserved.
 - `slash`: Deducts up to a value from the combined balance of `who`, preferring to deduct from the free balance. This function cannot fail.
 
-Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_balances/index.html) to learn more about the API provided by the Balances
+Please refer to the [official API documentation](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html) to learn more about the API provided by the Balances
diff --git a/pages/docs/build/pallets/consensus-mechanism.mdx b/pages/docs/build/pallets/consensus-mechanism.mdx
@@ -38,4 +38,4 @@ Key functions of the Staking pallet include:
 - `nominate`: A bonded account can nominate one or more validators to be elected.
 - `payout_stakers`: Pay the last reward to the stakers of a validator.
 
-Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_staking/index.html) to learn more about the API provided by the Staking pallet.
+Please refer to the [official API documentation](https://crates.parity.io/pallet_staking/index.html) to learn more about the API provided by the Staking pallet.
diff --git a/pages/docs/build/pallets/interoperability.mdx b/pages/docs/build/pallets/interoperability.mdx
@@ -1,4 +1,4 @@
 # Interoperability
 
 Tangle Network is designed to connect to other blockchains through bridges, and is specially designed to govern and host connections to Webb's bespoke Hubble Bridge, a private and interoperable transfer bridge.
-See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](/docs/projects/hubble-bridge/overview)
+See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](https://docs.webb.tools/docs/projects/hubble-bridge/overview/)
diff --git a/pages/docs/faqs.mdx → pages/docs/faq.mdx b/pages/docs/faqs.mdx → pages/docs/faq.mdx
@@ -19,7 +19,7 @@ The following specifications are the ideal or recommended, but nodes can be run
 | Memory    | 32GB ECC                                                                                               |
 | Firewall  | P2P port must be open to incoming traffic: <br /> - Source: Any <br /> - Destination: 30333, 30334 TCP |
 
-See https://docs.webb.tools/docs/ecosystem-roles/validator/requirements/ for more information.
+See [Hardware](https://docs.tangle.tools/docs/node/hardware/) and [Getting Started with Validating](https://docs.tangle.tools/docs/node/validator/requirements/) for more information.
 
 ## What about backup nodes?
 
@@ -60,23 +60,23 @@ We're working on this, check back soon!
 
 ## What are the recommendations for monitoring my node?
 
-Monitoring is critical for success as a node operator. See our full Monitoring guide at https://docs.webb.tools/docs/node/monitoring/quickstart//
+Monitoring is critical for success as a node operator. See our full [Monitoring guide](https://docs.tangle.tools/docs/node/monitoring/quickstart/)
 
 ## What are the KPIs I should be monitoring?
 
 The main key performance indicator for a node operator is the number of blocks produced. The Prometheus metric for this is called substrate_proposer_block_constructed_count.
 
 ## How should I set up alerting?
 
-Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager at https://docs.webb.tools/docs/node/monitoring/alert-manager/
+Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager (https://docs.tangle.tools/docs/node/monitoring/alert-manager/)
 
 ## What is the failover process if my primary node is down?
 
 When the primary server is down, the best way to perform a failover to the backup server is to perform a key association update. Each server should have a unique set of keys already. Run the setKeys author mapping extrinsic. You can follow the Mapping Extrinsic instructions and modify the instructions to use the setKeys extrinsic.
 
 ## What should I look for in the logs?
 
-For full support, see our guides on logging at https://docs.webb.tools/docs/node/monitoring/loki/.
+For full support, see our guides on [Logging](https://docs.tangle.tools/docs/node/monitoring/loki/).
 
 ## How much stake do I need to become a validator in the active set?
 

diff --git a/pages/docs/governance/democracy-voting.mdx b/pages/docs/governance/democracy-voting.mdx
@@ -28,4 +28,4 @@ Note: This guide assumes you have already set up a Substrate-based wallet and ha
 8. **Wait for the Voting Period to End:**
    Each referendum has a voting period. When this period ends, votes are tallied, and the decision is enacted based on the majority vote.
 
-Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](/docs/governance/governance-parameters/)
+Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](./governance-parameters.mdx)
diff --git a/pages/docs/governance/overview.mdx b/pages/docs/governance/overview.mdx
@@ -22,7 +22,7 @@ The governance system of Tangle Network is divided into two parts, the public re
 
 Proposals can be made by any token holder. Others can agree with the proposal by seconding it and providing tokens equivalent to the original bond. The most seconded proposal during every launch period is moved to the public referenda table for active voting. Voters can lock their tokens for a longer duration to amplify their vote.
 
-Detailed information on the governance system can be found [here](/docs/governance/overview/).
+Detailed information on the governance system can be found [here](https://marketplace.substrate.io/pallets/pallet-democracy/).
 
 ## Important Parameters for Democracy Module
 

diff --git a/pages/docs/network-information-configuration.mdx b/pages/docs/network-information-configuration.mdx
@@ -33,7 +33,7 @@ We will offer two types of block explorers to accommodate the Ethereum API and S
 
 | Block Explorer | Type      | URL                                                                                |
 | -------------- | --------- | ---------------------------------------------------------------------------------- |
-| BlockScout     | EVM       | [link](https://https://explorer.tangle.tools/)                                     |
+| BlockScout     | EVM       | [link](https://testnet-explorer.tangle.tools/)                                     |
 | PolkadotJS     | Substrate | [link](https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer) |
 
 ## Funding Your Accounts
@@ -54,7 +54,7 @@ As an Ethereum-compatible, Substrate-based chain, Tangle Network allows for the
 
 ## Participating in the Tangle Network
 
-Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](/docs/node/quickstart/), and [Contribution Guide](/docs/contribute).
+Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](./node/quickstart.mdx), and [Contribution Guide](./contribute.mdx).
 
 ## Looking Ahead: Mainnet Launches
 
@@ -64,21 +64,21 @@ Our official Mainnet launch date is forthcoming, so stay tuned! Post-launch, we'
 
 Users can participate by engaging in the following activities, you can share your contributions to [our Discord](https://webb.tools/community) in the `#contributions` channel.
 
-| Task                                           | Instructions                                                                                                                                       |
-| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Creative Contribution                          | -                                                                                                                                                  |
-| Use Case Concepts                              | User Submission. Write an article discussing a use case for the technologies Tangle uses!                                                          |
-| Publish a video or tutorial on Tangle/Webb     | Publish a high-quality video discussing the network or its privacy technologies.                                                                   |
-| Author a Protocol Extension                    | Create and submit an extension to the protocols used in Tangle. See our GitHub                                                                     |
-| Tweet about Webb                               | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network.                                                   |
-| Deposit → Transfer → Withdraw                  | Perform a transaction flow on the network or the Hubble Bridge.                                                                                    |
-| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol.                                                                                                                    |
-| Vote in Governance                             | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy)   |
-| Propose and Pass in Governance                 | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy)   |
-| Tweet an ETH address or ENS domain             | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network.                                                   |
-| Bug Bounty with PR Fix Submission              | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github.                                                               |
-| Run a validator                                | See our Docs on running a Validator Node                                                                                                           |
-| Scripts to make Transactions                   | Engineer and publish transaction scripts for the network                                                                                           |
-| Bug Report                                     | See the @Bug Reporting Guidance                                                                                                                    |
+| Task                                           | Instructions                                                                                                                                     |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Creative Contribution                          | -                                                                                                                                                |
+| Use Case Concepts                              | User Submission. Write an article discussing a use case for the technologies Tangle uses!                                                        |
+| Publish a video or tutorial on Tangle/Webb     | Publish a high-quality video discussing the network or its privacy technologies.                                                                 |
+| Author a Protocol Extension                    | Create and submit an extension to the protocols used in Tangle. See our GitHub                                                                   |
+| Tweet about Webb                               | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network.                                                 |
+| Deposit → Transfer → Withdraw                  | Perform a transaction flow on the network or the Hubble Bridge.                                                                                  |
+| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol.                                                                                                                  |
+| Vote in Governance                             | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
+| Propose and Pass in Governance                 | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) |
+| Tweet an ETH address or ENS domain             | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network.                                                 |
+| Bug Bounty with PR Fix Submission              | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github.                                                             |
+| Run a validator                                | See our Docs on running a Validator Node                                                                                                         |
+| Scripts to make Transactions                   | Engineer and publish transaction scripts for the network                                                                                         |
+| Bug Report                                     | See the @Bug Reporting Guidance                                                                                                                  |
 
 Stay updated by following our [Blog](https://blog.webb.tools /) and joining our [Community](https://webb.tools/community).
diff --git a/pages/docs/node/docker-node.mdx b/pages/docs/node/docker-node.mdx
@@ -9,7 +9,7 @@ import { Tabs } from 'nextra/components';
 # Deploying a Tangle Network Node with Docker
 
 A Tangle Network node can be spun up quickly using Docker. **This guide covers both Full Node and Validator Node deployment.** . For more information on installing Docker,
-please visit the official Docker [docs](https://docs.docker.com/get-docker/). Make sure that your system meets the requirements which can read [here](docs/node/hardware/).
+please visit the official Docker [docs](https://docs.docker.com/get-docker). Make sure that your system meets the requirements which can read [here](https://docs.tangle.tools/docs/node/hardware/).
 
 ## Setup the Docker Environment
 
@@ -65,7 +65,7 @@ docker run --rm -it -v /var/lib/tangle/:/data ghcr.io/webb-tools/tangle/tangle:m
 ```
 
 <Callout type="info">
-  For an overview of the above flags, please refer to the [CLI Usage](/docs/ecosystem-roles/validator/api-reference/cli/) page of our documentation.
+  For an overview of the above flags, please refer to the [Substrate node-template CLI Tool](https://docs.substrate.io/reference/command-line-tools/node-template).
 </Callout>
 
 Once Docker pulls the necessary images, your Tangle node will start, displaying lots of information,
@@ -80,7 +80,7 @@ relay chain, which might take a few days.
 
 ### Generate and store keys:
 
-We need to generate the required keys for our node. For more information on these keys, please see the [Required Keys](/docs/ecosystem-roles/validator/required-keys) section.
+We need to generate the required keys for our node. For more information on these keys, please see the [Required Keys](https://docs.tangle.tools/docs/node/validator/requirements/#2-generate-your-keys-and-import-them-to-the-keystore.mdx) section.
 The keys we need to generate include the following:
 
 - Role key (Ecdsa)
@@ -176,7 +176,7 @@ ghcr.io/webb-tools/tangle/tangle:main \
 ```
 
 <Callout type="info">
-  For an overview of the above flags, please refer to the [CLI Usage](/docs/ecosystem-roles/validator/api-reference/cli/) page of our documentation.
+  For an overview of the above flags, please refer to the [Substrate node-template CLI Tool](https://docs.substrate.io/reference/command-line-tools/node-template).
 </Callout>
 
 Once Docker pulls the necessary images, your Tangle node will start, displaying lots of information,
@@ -246,7 +246,7 @@ The upgrade process is straightforward and is the same for a full node.
 sudo docker stop `CONTAINER_ID`
 ```
 
-2. Get the latest version of Tangle from the Tangle GitHub Release [page](https://github.com/webb-tools/tangle/pkgs/container/tangle%2Ftangle
+2. Get the latest version of Tangle from the Tangle GitHub Release [page](https://github.com/webb-tools/tangle/pkgs/container/tangle%2Ftangle)
 
 3. Pull the latest version of Tangle binary by doing `docker pull ghcr.io/webb-tools/tangle/tangle:{VERSION_CODE}`.
    Example, if the latest version of Tangle is v0.1.2, then the command would be `docker pull ghcr.io/webb-tools/tangle/tangle:v0.1.12`
@@ -288,7 +288,7 @@ If you'd like to run the node with verbose logs, you may add the following argum
 
 ## Begin Validating
 
-Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](./validator/requirements.mdx)
+Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](https://docs.tangle.tools/docs/node/validator/requirements)
 
 ## Support and Questions