fix: update URLs, correct spelling, and improve phrasing #5134

sergeypanin1994 · 2025-01-13T22:14:49Z

fix: update URLs, correct spelling, and improve phrasing

Replaced outdated Twitter URL (https://twitter.com/) with the updated x.com format (https://x.com/)
Fixed spelling typo in "GitHub"
Corrected phrasing in documentation:
- Changed "entails upgrading" to "entails upgrading to"
- Corrected "failing to follow the chain errors" to "failing to follow chain errors"
- Replaced "it may make sense" with "it might make sense"
Fixed minor errors in metrics documentation:
- Replaced "telemetries" with "telemetry"
- Capitalized "Loki" and "Grafana"
- Corrected "docker compose" to "docker-compose"
- Fixed "stop your note" to "stop your node"

Replaced the outdated Twitter URL (https://twitter.com/) with the updated x.com format (https://x.com/) to align with the platform's rebranding.

- Changed "entails upgrading" to "entails upgrading to" - Corrected "failing to follow the chain errors" to "failing to follow chain errors" - Replaced "it may make sense" with "it might make sense" - Fixed "stop your note" to "stop your node"

- Changed "telemetries" to "telemetry" for correct usage - Capitalized "Loki" and "Grafana" to reflect proper nouns - Corrected "docker compose" to "docker-compose"

LesnyRumcajs · 2025-01-14T12:21:59Z

.config/spellcheck.md

@@ -6,7 +6,7 @@ We run spellchecks using
 It delegates to a program called
 [`Hunspell`](https://github.com/hunspell/hunspell).

-Hunspell accepts uses `dictionary` files for words and `affix` files to define
+Hunspell accept use `dictionary` files for words and `affix` files to define


This is still incorrect phrasing.

LesnyRumcajs · 2025-01-14T12:23:24Z

README.md

@@ -11,7 +11,7 @@
    <a href="https://github.com/ChainSafe/forest/blob/main/LICENSE-APACHE"><img alt="License Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge"></a>
    <a href="https://github.com/ChainSafe/forest/blob/main/LICENSE-MIT"><img alt="License MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge"></a>
    <a href="https://discord.gg/Q6A3YA2"><img alt="Discord" src="https://img.shields.io/discord/593655374469660673.svg?style=for-the-badge&label=Discord&logo=discord"></a>
-    <a href="https://twitter.com/ChainSafeth"><img alt="Twitter" src="https://img.shields.io/twitter/follow/chainsafeth?style=for-the-badge&color=1DA1F2"></a>
+    <a href="https://x.com/ChainSafeth"><img alt="Twitter" src="https://img.shields.io/x/follow/chainsafeth?style=for-the-badge&color=1DA1F2"></a>


The preview doesn't work, the link seems broken.

LesnyRumcajs · 2025-01-14T12:23:46Z

docs/docs/users/getting_started/install.md

@@ -10,15 +10,15 @@ import TabItem from "@theme/TabItem";
  <TabItem value="binaries" label="Binaries" default>

 To install Forest from pre-compiled binaries, please refer to the
-[releases page](https://github.com/ChainSafe/forest/releases), or consider using
+[releases page](https://GitHub.com/ChainSafe/forest/releases), or consider using


There is no point in doing that in URLs.

LesnyRumcajs · 2025-01-14T12:24:24Z

docs/docs/users/knowledge_base/network_upgrades_state_migrations.md

@@ -7,24 +7,24 @@ sidebar_position: 2

 Network upgrades happen periodically in Filecoin. They bring new features to the network, proposed via [FIPs](https://github.com/filecoin-project/FIPs) and are announced via several channels, including the [filecoin-project/community discussions](https://github.com/filecoin-project/community/discussions) and the Filecoin Slack. Also, all Filecoin implementations make the announcements on their own. In Forest's case, it's on [Forest's Discussions](https://github.com/ChainSafe/forest/discussions) and the `#fil-forest-announcements` channel in the Filecoin Slack.

-Some preparation is required for a smooth transition from one network version to another for node operators. Usually, this entails upgrading the node version only to a specified one before the upgrade - teams do their best to offer a final binary at least a week before the upgrade date.
+Some preparation is required for a smooth transition from one network version to another for node operators. Usually, this eentails upgrading to the node version only to a specified one before the upgrade - teams do their best to offer a final binary at least a week before the upgrade date.


This is incorrect.

LesnyRumcajs · 2025-01-14T12:24:39Z

docs/docs/users/knowledge_base/network_upgrades_state_migrations.md

 :::

 ## Avoiding migrations / node recovery

-Sometimes, it is not feasible to perform a network migration. If a node is hosted on a bare-metal server and not on a VPS, it might not be easy to have it upgraded. Fortunately, there is a way to avoid the painful migrations - Filecoin snapshots. The same applies when encountering an issue with your node (failing to follow the chain errors, consensus issues) - you should bootstrap the node from a fresh snapshot.
+Sometimes, it is not feasible to perform a network migration. If a node is hosted on a bare-metal server and not on a VPS, it might not be easy to have it upgraded. Fortunately, there is a way to avoid the painful migrations - Filecoin snapshots. The same applies when encountering an issue with your node (ffailing to follow chain errors, consensus issues) - you should bootstrap the node from a fresh snapshot.


This is incorrect.

LesnyRumcajs · 2025-01-14T12:25:11Z

documentation/src/introduction.md

@@ -11,7 +11,7 @@
 <p align="center">
    <a href="https://github.com/ChainSafe/forest/blob/main/LICENSE-APACHE"><img alt="License Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge"></a>
    <a href="https://github.com/ChainSafe/forest/blob/main/LICENSE-MIT"><img alt="License MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge"></a>
-    <a href="https://twitter.com/ChainSafeth"><img alt="Twitter" src="https://img.shields.io/twitter/follow/chainsafeth?style=for-the-badge&color=1DA1F2"></a>
+    <a href="https://x.com/ChainSafeth"><img alt="Twitter" src="https://img.shields.io/x/follow/chainsafeth?style=for-the-badge&color=1DA1F2"></a>


Same as in README.

LesnyRumcajs · 2025-01-14T12:27:44Z

monitoring/README.md

@@ -3,41 +3,41 @@
 ## Requirements

 1. `forest` node running locally
-2. `docker` & `docker compose` must be available in the `$PATH` (alternatively
+2. `docker` & `docker-compose` must be available in the `$PATH` (alternatively


docker compose is a valid subcommand for the new compose 2.x. docker-compose is 1.x.

LesnyRumcajs · 2025-01-14T12:28:07Z

monitoring/README.md

+3. Port `3000` for `Grafana` has to be free.
+4. Port `3100` for `Loki` has to be free.

 ## Run

-To run the metrics stack, use the provided Docker compose file to spawn the
-`prometheus`, `loki` and `grafana` containers.
+To run the metrics stack, use the provided docker-compose file to spawn the
+`prometheus`, `Loki` and `Grafana` containers.


LesnyRumcajs · 2025-01-14T12:29:20Z

Closing as it looks like an automated PR with plenty of obvious errors. Feel free to open a new one if this is not the case.

sergeypanin1994 added 5 commits January 14, 2025 01:04

fix: update Twitter URL to x.com format

4b2bfd0

Replaced the outdated Twitter URL (https://twitter.com/) with the updated x.com format (https://x.com/) to align with the platform's rebranding.

Fix spelling errors in documentation

6b320b5

Fix typo in "GitHub" spelling

87140d4

Fix minor errors in metrics documentation

ef8efcb

- Changed "telemetries" to "telemetry" for correct usage - Capitalized "Loki" and "Grafana" to reflect proper nouns - Corrected "docker compose" to "docker-compose"

sergeypanin1994 requested a review from a team as a code owner January 13, 2025 22:14

sergeypanin1994 requested review from hanabi1224 and sudo-shashank and removed request for a team January 13, 2025 22:14

LesnyRumcajs reviewed Jan 14, 2025

View reviewed changes

LesnyRumcajs closed this Jan 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: update URLs, correct spelling, and improve phrasing #5134

fix: update URLs, correct spelling, and improve phrasing #5134

sergeypanin1994 commented Jan 13, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs Jan 14, 2025

LesnyRumcajs commented Jan 14, 2025

fix: update URLs, correct spelling, and improve phrasing #5134

fix: update URLs, correct spelling, and improve phrasing #5134

Conversation

sergeypanin1994 commented Jan 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LesnyRumcajs commented Jan 14, 2025