From 73505b58f47c516cdab7e4f5f8c49c54c301ac75 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 25 Oct 2024 08:12:31 +0100 Subject: [PATCH 1/4] fixes link to style guide + tweaks --- docs/contribute/style-guide.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md index d790dee..5570536 100644 --- a/docs/contribute/style-guide.md +++ b/docs/contribute/style-guide.md @@ -8,13 +8,11 @@ sidebar_position: 2 Style guidelines help keep the Consensys documentation consistent, concise, and readable. Refer to the following guides when writing, editing, or reviewing doc content: -- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/) - - Refer to this guide for style, voice, grammar, and text formatting guidelines. -- [**Diátaxis framework**](https://diataxis.fr/) - Refer to this guide for information about +- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/): Refer to this guide for style, voice, grammar, and text formatting guidelines. +- [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about function-based docs. -- [**Consensys Editorial Style Guide**](https://docs.google.com/document/d/1smRdw4TUIpz9re_o0_0DKdH_nK6cSPMJOK6BcbhjJ7Y/edit?usp=sharing) - - Refer to this guide for spelling and usage of blockchain-related terms. - This guide is only available to internal Consensys contributors. +- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](/run-vale) assist writers to adhere to this style. + > This guide is only available to internal Consensys contributors. The following section also highlights the top five style tips from these guides. @@ -54,7 +52,7 @@ in your writing: :::info example -❌ *If we are unable to find another library that works with the execution environment, another way +❌ *If we're unable to find another library that works with the execution environment, another way of solving the problem is by patching the dependency ourselves. For this, `patch-package` can be leveraged.* @@ -69,10 +67,10 @@ Write for a [developer audience](https://learn.microsoft.com/en-us/style-guide/d - You don't need to market the product to the reader. Understand what they're seeking to learn or do, and optimize your content to help them achieve - that quickly. + that fast. - List prerequisites and suggest good practices. For example, instruct readers to secure private keys and protect RPC endpoints in production environments. -- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be easily +- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be copied and pasted, and work as expected. :::info example @@ -152,7 +150,7 @@ elements](https://learn.microsoft.com/en-us/style-guide/text-formatting/): ❌ *[Click here](https://discord.gg/hyperledger) for Besu support.* -✅ *If you have questions about Besu for public networks, ask on the **besu** channel on +✅ *If you have questions about Besu for public networks, ask on the **Besu** channel on [Hyperledger Discord](https://discord.gg/hyperledger).* ::: From 4cb8ed7f8e3cb9ea15d2e27fbef788b4d5ddea43 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 25 Oct 2024 08:14:51 +0100 Subject: [PATCH 2/4] fixes relative link --- docs/contribute/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md index 5570536..8246d0d 100644 --- a/docs/contribute/style-guide.md +++ b/docs/contribute/style-guide.md @@ -11,7 +11,7 @@ Refer to the following guides when writing, editing, or reviewing doc content: - [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/): Refer to this guide for style, voice, grammar, and text formatting guidelines. - [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about function-based docs. -- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](/run-vale) assist writers to adhere to this style. +- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](/run-vale.md) assists writers to adhere to this style. > This guide is only available to internal Consensys contributors. The following section also highlights the top five style tips from these guides. From 9c8f806a89671be972b6825f2b8db3e5748b19ae Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 25 Oct 2024 11:01:02 +0100 Subject: [PATCH 3/4] tidy up for POC to prod --- README.md | 14 -------------- docs/contribute/style-guide.md | 2 +- 2 files changed, 1 insertion(+), 15 deletions(-) diff --git a/README.md b/README.md index f5a7aa2..1a7e4eb 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,3 @@ It's built using [Docusaurus](https://docusaurus.io/). It also contains a written guide for contributing to Consensys docs, and creating, configuring, and testing new doc sites, published at [`docs-template.consensys.net`](https://docs-template.consensys.net/). - -## Linting - -Vale is a work in progress (WIP) for linting: `.github/workflows/lint.yml` uses actions set up on -Consensys/docs-gha/lint@main. - -WIP: That GHA repo should be set up to apply the [Vale linting set](https://github.com/ConsenSys/docs-gha/tree/main/spelling). - -### Let's Upset Vale - -The title should do it, so should: - -- Metamask -- ConsenSys diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md index 8246d0d..f55d008 100644 --- a/docs/contribute/style-guide.md +++ b/docs/contribute/style-guide.md @@ -11,7 +11,7 @@ Refer to the following guides when writing, editing, or reviewing doc content: - [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/): Refer to this guide for style, voice, grammar, and text formatting guidelines. - [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about function-based docs. -- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](/run-vale.md) assists writers to adhere to this style. +- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](run-vale.md) assists writers to adhere to this style. > This guide is only available to internal Consensys contributors. The following section also highlights the top five style tips from these guides. From 64167947816d98402a69b69a9f013d7cd3d07f09 Mon Sep 17 00:00:00 2001 From: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com> Date: Wed, 30 Oct 2024 14:50:26 -0700 Subject: [PATCH 4/4] Update docs/contribute/style-guide.md --- docs/contribute/style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md index 0669d77..07d2e95 100644 --- a/docs/contribute/style-guide.md +++ b/docs/contribute/style-guide.md @@ -152,7 +152,7 @@ elements](https://learn.microsoft.com/en-us/style-guide/text-formatting/): ❌ *[Click here](https://discord.gg/hyperledger) for Besu support.* -✅ *If you have questions about Besu for public networks, ask on the **Besu** channel on -[Hyperledger Discord](https://discord.gg/hyperledger).* +✅ *If you have questions about Besu for public networks, ask on the **#besu** channel on +[LFDT Discord](https://discord.gg/hyperledger).* :::