From a9a42f56ddd0e1876f11ce4fec3546bbb73cf8ad Mon Sep 17 00:00:00 2001 From: Hubert Bugaj Date: Wed, 11 Mar 2026 17:27:02 +0100 Subject: [PATCH] chore: remove workaround for HTML tags --- .config/forest.dic | 9 +++++++-- .config/spellcheck.toml | 4 ++++ CONTRIBUTING.md | 2 +- README.md | 3 +-- docs/docs/users/filecoin_services.md | 6 +++--- docs/docs/users/introduction.md | 2 +- mise-tasks/lint/spellcheck-markdown.sh | 20 +------------------- 7 files changed, 18 insertions(+), 28 deletions(-) diff --git a/.config/forest.dic b/.config/forest.dic index 19783b3b5724..bee8d2806ef7 100644 --- a/.config/forest.dic +++ b/.config/forest.dic @@ -1,4 +1,4 @@ -262 +267 Algorand/M API's API/SM @@ -10,10 +10,13 @@ arity async attoFIL autogenerated +autolink/S automagically backend/S backfill +backfilling backport +backtick/S behaviour benchmark/GD benchmarking @@ -39,7 +42,6 @@ CARv1/SM CARv2/SM CBOR Chainlist -chainsafe ChainSafe/M CHANGELOG changelog/S @@ -58,12 +60,14 @@ crypto daemon daemonize Datacap +datacap DB/S DDL deduplicates dep/S deserialize/D destructuring +dev devnet Devs DHT @@ -111,6 +115,7 @@ hardcoded hasher healthcheck hotfix +Hypercerts IaC implementer/S implementor/SM diff --git a/.config/spellcheck.toml b/.config/spellcheck.toml index cc56a4533a6b..7a4a9db9d0a7 100644 --- a/.config/spellcheck.toml +++ b/.config/spellcheck.toml @@ -22,6 +22,10 @@ transform_regex = [ "^.{1,2}$", # Version references like NV17, NV23, v21, FVM2 "^[a-zA-Z]+[0-9]+$", + # Placeholder tokens like FIPXX, NVXX, FIPZZ + "^[A-Z]+XX$", + "^[A-Z]+YY$", + "^[A-Z]+ZZ$", # @-prefixed tokens (e.g., @theme imports in MDX) "^@", # Approximate values like ~14, ~80 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c41cbab9c73..b2bd7287885a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -225,7 +225,7 @@ eternally grateful and hope you will continue to contribute to the project. ### 📚 Improving The Documentation The documentation is currently hosted on -[docs.forest.chainsafe.io](https://docs.forest.chainsafe.io/). If you find any +[Forest Documentation](https://docs.forest.chainsafe.io/). If you find any issues with the documentation, please create an issue or contribute to the [docs directory](docs). ## Style Guides diff --git a/README.md b/README.md index 80964c7eaf71..d4dea60f417b 100644 --- a/README.md +++ b/README.md @@ -277,7 +277,7 @@ confirmed, we will take all necessary precautions to ensure a statement and patch release is made in a timely manner. Please email a description of the flaw and any related information (e.g. -reproduction steps, version) to [security at chainsafe dot io]. +reproduction steps, version) to `security (at) chainsafe (dot) io`. ## License @@ -290,6 +290,5 @@ Forest is dual licensed under [MIT] + [Apache 2.0]. [Forest Q&A]: https://github.com/ChainSafe/forest/discussions/categories/forest-q-a [CONTRIBUTING.md]: CONTRIBUTING.md [Forest IaC]: https://github.com/ChainSafe/forest-iac -[security at chainsafe dot io]: mailto:security@chainsafe.io [MIT]: https://github.com/ChainSafe/forest/blob/main/LICENSE-MIT [Apache 2.0]: https://github.com/ChainSafe/forest/blob/main/LICENSE-APACHE diff --git a/docs/docs/users/filecoin_services.md b/docs/docs/users/filecoin_services.md index 94cb9c63e0ad..67c629a54ad1 100644 --- a/docs/docs/users/filecoin_services.md +++ b/docs/docs/users/filecoin_services.md @@ -30,7 +30,7 @@ Actively-maintained repositories that are part of the Forest project are: ## Forest Explorer Faucet -Forest Explorer Faucet is a serverless application that allows users to request FIL on both mainnet and calibnet. The faucet is available at [forest-explorer.chainsafe.dev/faucet](https://forest-explorer.chainsafe.dev/faucet). The code is open source and available at [github.com/ChainSafe/forest-explorer](https://github.com/ChainSafe/forest-explorer). +Forest Explorer Faucet is a serverless application that allows users to request FIL on both mainnet and calibnet. The faucet is available at [Forest Explorer](https://forest-explorer.chainsafe.dev/faucet). The code is open source and available at [GitHub](https://github.com/ChainSafe/forest-explorer). ## Bootstrap Nodes @@ -77,14 +77,14 @@ To download the latest snapshots (`v2` by default, as outlined in [`FRC-108`](ht ## Filecoin Archive -Filecoin Archive is a collection of Filecoin snapshots aiming to provide a historical record of the Filecoin network. The archive is available at [forest-archive.chainsafe.dev](https://forest-archive.chainsafe.dev). +Filecoin Archive is a collection of Filecoin snapshots aiming to provide a historical record of the Filecoin network. The archive is available at [Forest Archive](https://forest-archive.chainsafe.dev). ## Calibnet FIL and Datacap Faucet [Lotus Fountain](https://github.com/filecoin-project/lotus/blob/master/cmd/lotus-fountain/main.go)-based faucet for calibnet FIL and datacap. The faucet is available at [faucet.calibnet.chainsafe-fil.io](https://faucet.calibnet.chainsafe-fil.io). :::tip -You can check the status of many ChainSafe services at [status.chainsafe.dev](https://status.chainsafe.dev). +You can check the status of many ChainSafe services at [ChainSafe Status](https://status.chainsafe.dev). ::: :::info diff --git a/docs/docs/users/introduction.md b/docs/docs/users/introduction.md index 32a0052ae59f..38ce8d19dd8f 100644 --- a/docs/docs/users/introduction.md +++ b/docs/docs/users/introduction.md @@ -52,7 +52,7 @@ Checkout [GitHub Discussions](https://github.com/ChainSafe/forest/discussions/ca - Questions, Comments, Feedback: - [Filecoin Slack](https://filecoin.io/slack): `#fil-forest-help`, `#fil-forest-dev` or `#fil-forest-announcements` - [Forest GitHub Discussions](https://github.com/ChainSafe/forest/discussions) -- Partnerships or Hand-on Support: forest (at) chainsafe [dot] io +- Partnerships or Hand-on Support: `forest (at) chainsafe [dot] io` ## Contributing diff --git a/mise-tasks/lint/spellcheck-markdown.sh b/mise-tasks/lint/spellcheck-markdown.sh index 3a9a0bb4361a..7aedee9d1815 100755 --- a/mise-tasks/lint/spellcheck-markdown.sh +++ b/mise-tasks/lint/spellcheck-markdown.sh @@ -1,31 +1,13 @@ #!/bin/bash #MISE description="Run cargo-spellcheck to check for spelling errors in Markdown files." -# cargo-spellcheck has a bug where leading HTML blocks cause the rest of the -# file to be silently skipped. Work around this by stripping leading HTML -# before checking. See https://github.com/drahnr/cargo-spellcheck/issues/357 set -euo pipefail -TMPDIR=$(mktemp -d) -trap "rm -rf $TMPDIR" EXIT - FILES=$(find . -name "*.md" \ -not -path "*/node_modules/*" \ -not -path "*/target/*" \ -not -path "*/.git/*" \ -not -path "*/CHANGELOG.md") -for f in $FILES; do - DEST="$TMPDIR/$f" - mkdir -p "$(dirname "$DEST")" - # Strip leading HTML blocks (lines starting with < or blank, before first non-HTML line) - awk ' - BEGIN { in_leading_html = 1 } - in_leading_html && /^[[:space:]]*$/ { next } - in_leading_html && /^[[:space:]]* "$DEST" -done - -cargo spellcheck check --code 1 $TMPDIR/*.md $TMPDIR/**/*.md \ +cargo spellcheck check --code 1 $FILES \ || (echo "See .config/spellcheck.md for tips"; false)