Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 2 additions & 22 deletions .config/lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,13 @@

verbose = "debug"
no_progress = true
exclude_path = ["./node_modules", "./docs/node_modules", "./documentation", "./target"]
# docs are checked via Docusaurus link checker, so we can skip them here
exclude_path = ["./node_modules", "./target", "./docs/", "./build"]
exclude = [
# Avoid Github rate limits
"github.com/ChainSafe/forest",
# Requires CAPTCHA verification
"faucet.calibnet.chainsafe-fil.io/funds.html",
# Bot protection
"jwt.io",
"forest-explorer.chainsafe.dev",
# Maybe temporarily down with 404, but it blocks the CI
"filecoin.io/slack",
# Bot protection / 403 Forbidden errors
"crates.io",
# Bot protection / 403 Forbidden errors
"linuxhint.com",
# Bot protection / 403 Forbidden errors
"wikipedia.org",
# Probably bot protection / 404 but works in browser
"ubuntu.com",
# Bot protection / 403 Forbidden errors
"beryx.io/faucet",
# Frequent timeouts
"curiostorage.org",
# Bot protection / 403 Forbidden errors
"probelab.io",
# Bot protection / 403 Forbidden errors
"beryx.io",
]
timeout = 30
max_retries = 6
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
id: lychee
uses: lycheeverse/lychee-action@v2
with:
args: --user-agent "curl/8.5.0" --no-progress --config ./.config/lychee.toml './**/*.md' './**/*.mdx' './**/*.html'
args: --user-agent "curl/8.5.0" --no-progress --config ./.config/lychee.toml './*.md' './AGENTS.md'

- name: Create Issue From File
if: env.lychee_exit_code != 0 && github.event_name == 'schedule'
Expand Down
5 changes: 2 additions & 3 deletions docs/docs/developers/guides/rpc_stateful_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,8 @@ The goal is to ensure that Forest now passes all the existing scenarios. These s

To extend test coverage for another RPC method or cover more semantics:

1. Add the RPC method to Forest if not yet implemented, following the guidance in [RPC compatibility guide](./rpc_api_compatibility.md).
2. Create a new test scenario in:
[`stateful_tests.rs`](../../../../src/tool/subcommands/api_cmd/stateful_tests.rs)
1. Add the RPC method to Forest if not yet implemented, following the guidance in [RPC compatibility guide](./rpc_api_compatibility).
2. Create a new test scenario in the `src/tool/subcommands/api_cmd/stateful_tests.rs` file
3. Your internal test function should return `Ok(())` on success. Use `anyhow::Result` for error handling.

Ensure the test behaves consistently on both Lotus and Forest nodes.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/users/filecoin_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ You can check the status of many ChainSafe services at [status.chainsafe.dev](ht
:::

:::info
Questions? Issues? Feedback? [Connect with the Forest team](./introduction.md#connect-with-us).
Questions? Issues? Feedback? [Connect with the Forest team](/#connect-with-us).

We are also active on the following channels on the [Filecoin Slack](https://filecoin.io/slack). Reach out to us for any questions or issues:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/users/getting_started/syncing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Syncing from genesis (tipset 0) is generally infeasible.

:::

Once started, Forest will connect to the bootstrap peers and in parallel fetch the latest snapshot from [Forest's snapshot service](../knowledge_base/snapshot_service.md). Once the snapshot is downloaded, it will be loaded into the node, and then syncing will continue by utilizing its peers.
Once started, Forest will connect to the bootstrap peers and in parallel fetch the latest snapshot from [Forest's snapshot service](../knowledge_base/snapshot_service). Once the snapshot is downloaded, it will be loaded into the node, and then syncing will continue by utilizing its peers.

### Mainnet

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/users/guides/advanced/backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ recommended outside development.

### CLI reference

Details on the `forest-tool backup` command and its subcommands can be found at the [CLI reference](../../reference/cli.md#forest-tool-backup).
Details on the `forest-tool backup` command and its subcommands can be found at the [CLI reference](../../reference/cli#forest-tool-backup).
2 changes: 1 addition & 1 deletion docs/docs/users/guides/advanced/generating_snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ expect a file of over 5 GB. Note that the snapshot size grows over time.

### CLI reference

Details on the `forest-cli snapshot export` command and its subcommands can be found at the [CLI reference](../../reference/cli.md#forest-cli-snapshot).
Details on the `forest-cli snapshot export` command and its subcommands can be found at the [CLI reference](../../reference/cli#forest-cli-snapshot).
4 changes: 2 additions & 2 deletions docs/docs/users/guides/exporting_wallet_to_metamask.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This guide walks you through exporting a Forest wallet (`f4` address) to MetaMas

:::info

You can list your wallets and their balances using `forest-wallet list`. Make sure to identify the correct `f4` address you want to export. Refer to the [wallets guide](./interacting_with_wallets.md) for more details on managing wallets in Forest.
You can list your wallets and their balances using `forest-wallet list`. Make sure to identify the correct `f4` address you want to export. Refer to the [wallets guide](./interacting_with_wallets) for more details on managing wallets in Forest.

:::

Expand Down Expand Up @@ -97,5 +97,5 @@ MetaMask displays addresses in Ethereum format (`0x...`). This is normal - it's

## Related Resources

- [Interacting with Wallets](./interacting_with_wallets.md)
- [Interacting with Wallets](./interacting_with_wallets)
- [Filecoin Address Types](https://docs.filecoin.io/smart-contracts/filecoin-evm-runtime/address-types)
2 changes: 1 addition & 1 deletion docs/docs/users/guides/methods_filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 4
When running a Filecoin node, you might want to restrict the RPC methods that are available to the clients. This can be useful for security reasons, to limit the exposure of the node to the internet, or to reduce the load on the node by disabling unnecessary methods.

:::note
[JWT authentication](../knowledge_base/jwt_handling.md) is a different way to restrict access to the node. It allows you to authorize certain operations on the node using JWTs. However, JWT restrictions are hard-coded in the node and cannot be changed dynamically. If you want to make sure that a certain read-only method is not available to the clients, you can use the method filtering feature.
[JWT authentication](../knowledge_base/jwt_handling) is a different way to restrict access to the node. It allows you to authorize certain operations on the node using JWTs. However, JWT restrictions are hard-coded in the node and cannot be changed dynamically. If you want to make sure that a certain read-only method is not available to the clients, you can use the method filtering feature.

The methods are first filtered by the method filtering feature, and then the JWT authentication is applied. If a method is disallowed by the method filtering, the JWT token will not be checked for this method.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/users/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Forest consists of multiple binaries:
- `forest-tool` - Utilities for maintaining and debugging Forest
- `forest-wallet` - Manage the built-in wallet

Check out the [CLI docs](./reference/cli.md) for more details.
Check out the [CLI docs](./reference/cli) for more details.

## Roadmap Updates

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/users/knowledge_base/docker_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ docker run --init -it --rm --entrypoint forest-tool ghcr.io/chainsafe/forest:lat
docker run --init -it --rm --entrypoint forest-wallet ghcr.io/chainsafe/forest:latest --help
```

Also see the [CLI documentation](../reference/cli.md) for more details about commands and
Also see the [CLI documentation](../reference/cli) for more details about commands and
their usage.

### Run a Forest node with custom environment variables
Expand All @@ -79,7 +79,7 @@ their usage.
docker run --init -it --rm --name forest --env <key>=<value> ghcr.io/chainsafe/forest:latest --chain calibnet --auto-download-snapshot
```

Check [Forest environment variables documentation](../reference/env_variables.md) for more details.
Check [Forest environment variables documentation](../reference/env_variables) for more details.

### Create a Forest node running calibration network. Then list all connected peers.

Expand Down
Loading
Loading