You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
- 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.
18
16
19
17
The following section also highlights the top five style tips from these guides.
20
18
@@ -54,7 +52,7 @@ in your writing:
54
52
55
53
:::info example
56
54
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
58
56
of solving the problem is by patching the dependency ourselves.
59
57
For this, `patch-package` can be leveraged.*
60
58
@@ -69,10 +67,10 @@ Write for a [developer audience](https://learn.microsoft.com/en-us/style-guide/d
69
67
70
68
- You don't need to market the product to the reader.
71
69
Understand what they're seeking to learn or do, and optimize your content to help them achieve
72
-
that quickly.
70
+
that fast.
73
71
- List prerequisites and suggest good practices.
74
72
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
0 commit comments