Linkcheck script improvements (smartcontractkit#2294)

* linkcheck improvements
dorianbayart · Jan 31, 2025 · 3ed7490 · 3ed7490
1 parent f2c9b38
commit 3ed7490
Show file tree

Hide file tree

Showing 9 changed files with 210 additions and 111 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
+server.log
 
 # environment variables
 .env

diff --git a/src/content/ccip/api-reference/v1.5.0/burn-from-mint-token-pool.mdx b/src/content/ccip/api-reference/v1.5.0/burn-from-mint-token-pool.mdx
@@ -14,7 +14,7 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
 
 ## BurnFromMintTokenPool
 
-[`BurnFromMintTokenPool`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnFromMintTokenPool.sol) is a concrete implementation that inherits from [`BurnMintTokenPoolAbstract`](/ccip/api-reference/burn-mint-token-pool-abstract). It is designed to mint and burn a 3rd-party token, using the `burnFrom(address, amount)` function for burning tokens, where the contract burns tokens from its own balance. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
+[`BurnFromMintTokenPool`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnFromMintTokenPool.sol) is a concrete implementation that inherits from [`BurnMintTokenPoolAbstract`](/ccip/api-reference/v1.5.0/burn-mint-token-pool-abstract). It is designed to mint and burn a 3rd-party token, using the `burnFrom(address, amount)` function for burning tokens, where the contract burns tokens from its own balance. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
 
 ## Variables
 

diff --git a/src/content/ccip/api-reference/v1.5.0/burn-mint-token-pool-abstract.mdx b/src/content/ccip/api-reference/v1.5.0/burn-mint-token-pool-abstract.mdx
@@ -14,7 +14,7 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
 
 ## BurnMintTokenPoolAbstract
 
-[`BurnMintTokenPoolAbstract`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPoolAbstract.sol) is an abstract contract that extends the [`TokenPool`](/ccip/api-reference/token-pool) contract. It defines the common logic for burning tokens in the pool. This contract contains validation mechanisms and logic for burning tokens in the context of a cross-chain token transfer. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
+[`BurnMintTokenPoolAbstract`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPoolAbstract.sol) is an abstract contract that extends the [`TokenPool`](/ccip/api-reference/v1.5.0/token-pool) contract. It defines the common logic for burning tokens in the pool. This contract contains validation mechanisms and logic for burning tokens in the context of a cross-chain token transfer. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
 
 ## Functions
 

diff --git a/src/content/ccip/api-reference/v1.5.0/burn-mint-token-pool.mdx b/src/content/ccip/api-reference/v1.5.0/burn-mint-token-pool.mdx
@@ -14,7 +14,7 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
 
 ## BurnMintTokenPool
 
-[`BurnMintTokenPool`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPool.sol) is a concrete implementation that inherits from [`BurnMintTokenPoolAbstract`](/ccip/api-reference/burn-mint-token-pool-abstract). It is designed to mint and burn a 3rd-party token, using the `burn(amount)` function for burning tokens. Pool whitelisting mode is set during the contract's deployment and cannot be modified later.
+[`BurnMintTokenPool`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPool.sol) is a concrete implementation that inherits from [`BurnMintTokenPoolAbstract`](/ccip/api-reference/v1.5.0/burn-mint-token-pool-abstract). It is designed to mint and burn a 3rd-party token, using the `burn(amount)` function for burning tokens. Pool whitelisting mode is set during the contract's deployment and cannot be modified later.
 
 ## Variables
 

diff --git a/src/content/ccip/api-reference/v1.5.0/ccip-receiver.mdx b/src/content/ccip/api-reference/v1.5.0/ccip-receiver.mdx
@@ -61,9 +61,9 @@ will move to a FAILED state and become available for manual execution.
 
 #### Parameters
 
-| Name    | Type                                                                      | Description  |
-| ------- | ------------------------------------------------------------------------- | ------------ |
-| message | struct [Client.Any2EVMMessage](/ccip/api-reference/client#any2evmmessage) | CCIP Message |
+| Name    | Type                                                                             | Description  |
+| ------- | -------------------------------------------------------------------------------- | ------------ |
+| message | struct [Client.Any2EVMMessage](/ccip/api-reference/v1.5.0/client#any2evmmessage) | CCIP Message |
 
 ### \_ccipReceive
 
@@ -75,9 +75,9 @@ Override this function in your implementation.
 
 #### Parameters
 
-| Name    | Type                                                                      | Description    |
-| ------- | ------------------------------------------------------------------------- | -------------- |
-| message | struct [Client.Any2EVMMessage](/ccip/api-reference/client#any2evmmessage) | Any2EVMMessage |
+| Name    | Type                                                                             | Description    |
+| ------- | -------------------------------------------------------------------------------- | -------------- |
+| message | struct [Client.Any2EVMMessage](/ccip/api-reference/v1.5.0/client#any2evmmessage) | Any2EVMMessage |
 
 ### getRouter
 

diff --git a/src/content/ccip/api-reference/v1.5.0/i-router-client.mdx b/src/content/ccip/api-reference/v1.5.0/i-router-client.mdx
@@ -102,10 +102,10 @@ _returns 0 fees on invalid message._
 
 #### Parameters
 
-| Name                     | Type                                                                      | Description                                                |
-| ------------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------- |
-| destinationChainSelector | uint64                                                                    | The destination chainSelector                              |
-| message                  | struct [Client.EVM2AnyMessage](/ccip/api-reference/client#evm2anymessage) | The cross-chain CCIP message, including data and/or tokens |
+| Name                     | Type                                                                             | Description                                                |
+| ------------------------ | -------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| destinationChainSelector | uint64                                                                           | The destination chainSelector                              |
+| message                  | struct [Client.EVM2AnyMessage](/ccip/api-reference/v1.5.0/client#evm2anymessage) | The cross-chain CCIP message, including data and/or tokens |
 
 #### Return Values
 
@@ -127,10 +127,10 @@ Request a message to be sent to the destination chain.
 
 #### Parameters
 
-| Name                     | Type                                                                      | Description                                                |
-| ------------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------- |
-| destinationChainSelector | uint64                                                                    | The destination chain ID                                   |
-| message                  | struct [Client.EVM2AnyMessage](/ccip/api-reference/client#evm2anymessage) | The cross-chain CCIP message, including data and/or tokens |
+| Name                     | Type                                                                             | Description                                                |
+| ------------------------ | -------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| destinationChainSelector | uint64                                                                           | The destination chain ID                                   |
+| message                  | struct [Client.EVM2AnyMessage](/ccip/api-reference/v1.5.0/client#evm2anymessage) | The cross-chain CCIP message, including data and/or tokens |
 
 #### Return Values
 

diff --git a/src/content/ccip/api-reference/v1.5.0/lock-release-token-pool.mdx b/src/content/ccip/api-reference/v1.5.0/lock-release-token-pool.mdx
@@ -16,7 +16,7 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
 
 The [`LockReleaseTokenPool`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/pools/LockReleaseTokenPool.sol) contract is used for handling tokens on their native chain using a lock and release mechanism. It allows tokens to be locked in the pool, facilitating their transfer across blockchains, and then released to the recipient on the destination chain. When allowlist is enabled, it ensures only token-developer specified addresses can transfer tokens.
 
-This contract inherits from the [`TokenPool`](/ccip/api-reference/token-pool) contract and implements additional functions for liquidity management.
+This contract inherits from the [`TokenPool`](/ccip/api-reference/v1.5.0/token-pool) contract and implements additional functions for liquidity management.
 
 ### typeAndVersion
 

diff --git a/src/content/ccip/api-reference/v1.5.0/registry-module-owner-custom.mdx b/src/content/ccip/api-reference/v1.5.0/registry-module-owner-custom.mdx
@@ -12,7 +12,7 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
 
 <CcipCommon callout="importCCIPPackage150" />
 
-The [`RegistryModuleOwnerCustom`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/tokenAdminRegistry/RegistryModuleOwnerCustom.sol) contract is responsible for registering the administrator of a token in the [`TokenAdminRegistry`](/ccip/api-reference/token-admin-registry). This contract allows for the registration of token administrators through either the `getCCIPAdmin()` method (for tokens with a CCIP admin) or the `owner()` method (for standard tokens with an owner). The contract enforces that only the rightful administrator of the token can register themselves, ensuring secure and accurate registration within the `TokenAdminRegistry`. The contract also emits an event, `AdministratorRegistered`, whenever a token administrator is successfully registered.
+The [`RegistryModuleOwnerCustom`](https://github.com/smartcontractkit/ccip/tree/release/contracts-ccip-1.5.0/contracts/src/v0.8/ccip/tokenAdminRegistry/RegistryModuleOwnerCustom.sol) contract is responsible for registering the administrator of a token in the [`TokenAdminRegistry`](/ccip/api-reference/v1.5.0/token-admin-registry). This contract allows for the registration of token administrators through either the `getCCIPAdmin()` method (for tokens with a CCIP admin) or the `owner()` method (for standard tokens with an owner). The contract enforces that only the rightful administrator of the token can register themselves, ensuring secure and accurate registration within the `TokenAdminRegistry`. The contract also emits an event, `AdministratorRegistered`, whenever a token administrator is successfully registered.
 
 ## Errors