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
9 changes: 7 additions & 2 deletions .config/forest.dic
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
262
267
Algorand/M
API's
API/SM
Expand All @@ -10,10 +10,13 @@ arity
async
attoFIL
autogenerated
autolink/S
automagically
backend/S
backfill
backfilling
backport
backtick/S
behaviour
benchmark/GD
benchmarking
Expand All @@ -39,7 +42,6 @@ CARv1/SM
CARv2/SM
CBOR
Chainlist
chainsafe
ChainSafe/M
CHANGELOG
changelog/S
Expand All @@ -58,12 +60,14 @@ crypto
daemon
daemonize
Datacap
datacap
DB/S
DDL
deduplicates
dep/S
deserialize/D
destructuring
dev
devnet
Devs
DHT
Expand Down Expand Up @@ -111,6 +115,7 @@ hardcoded
hasher
healthcheck
hotfix
Hypercerts
IaC
implementer/S
implementor/SM
Expand Down
4 changes: 4 additions & 0 deletions .config/spellcheck.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
6 changes: 3 additions & 3 deletions docs/docs/users/filecoin_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
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 @@ -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`
Comment thread
LesnyRumcajs marked this conversation as resolved.

## Contributing

Expand Down
20 changes: 1 addition & 19 deletions mise-tasks/lint/spellcheck-markdown.sh
Original file line number Diff line number Diff line change
@@ -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:]]*</ { next }
{ in_leading_html = 0; print }
' "$f" > "$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)
Loading