Skip to content

Commit 73505b5

Browse files
committed
fixes link to style guide + tweaks
1 parent 4d5077c commit 73505b5

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/contribute/style-guide.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ sidebar_position: 2
88
Style guidelines help keep the Consensys documentation consistent, concise, and readable.
99
Refer to the following guides when writing, editing, or reviewing doc content:
1010

11-
- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/) -
12-
Refer to this guide for style, voice, grammar, and text formatting guidelines.
13-
- [**Diátaxis framework**](https://diataxis.fr/) - Refer to this guide for information about
11+
- [**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.
12+
- [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about
1413
function-based docs.
15-
- [**Consensys Editorial Style Guide**](https://docs.google.com/document/d/1smRdw4TUIpz9re_o0_0DKdH_nK6cSPMJOK6BcbhjJ7Y/edit?usp=sharing)
16-
- Refer to this guide for spelling and usage of blockchain-related terms.
17-
This guide is only available to internal Consensys contributors.
14+
- [**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.
15+
> This guide is only available to internal Consensys contributors.
1816
1917
The following section also highlights the top five style tips from these guides.
2018

@@ -54,7 +52,7 @@ in your writing:
5452

5553
:::info example
5654

57-
*If we are unable to find another library that works with the execution environment, another way
55+
*If we're unable to find another library that works with the execution environment, another way
5856
of solving the problem is by patching the dependency ourselves.
5957
For this, `patch-package` can be leveraged.*
6058

@@ -69,10 +67,10 @@ Write for a [developer audience](https://learn.microsoft.com/en-us/style-guide/d
6967

7068
- You don't need to market the product to the reader.
7169
Understand what they're seeking to learn or do, and optimize your content to help them achieve
72-
that quickly.
70+
that fast.
7371
- List prerequisites and suggest good practices.
7472
For example, instruct readers to secure private keys and protect RPC endpoints in production environments.
75-
- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be easily
73+
- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be
7674
copied and pasted, and work as expected.
7775

7876
:::info example
@@ -152,7 +150,7 @@ elements](https://learn.microsoft.com/en-us/style-guide/text-formatting/):
152150

153151
*[Click here](https://discord.gg/hyperledger) for Besu support.*
154152

155-
*If you have questions about Besu for public networks, ask on the **besu** channel on
153+
*If you have questions about Besu for public networks, ask on the **Besu** channel on
156154
[Hyperledger Discord](https://discord.gg/hyperledger).*
157155

158156
:::

0 commit comments

Comments
 (0)