From 44df1327fb7018187bf15a4ae4c76218160a2914 Mon Sep 17 00:00:00 2001 From: Cat McGee Date: Tue, 27 Feb 2024 17:39:08 +0900 Subject: [PATCH] feat(docs): Meta doc typo fixes (#4779) Please read [contributing guidelines](CONTRIBUTING.md) and remove this line. --- docs/HOW_WE_WRITE_DOCS.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/HOW_WE_WRITE_DOCS.md b/docs/HOW_WE_WRITE_DOCS.md index fec3f5fa8a3..1bb47971024 100644 --- a/docs/HOW_WE_WRITE_DOCS.md +++ b/docs/HOW_WE_WRITE_DOCS.md @@ -50,10 +50,10 @@ To keep docs consistent and easily-searchable, follow these grammar guidelines: * Write with American English * When talking about ZK, use: -** `zero knowledge` as the noun -** `zero-knowledge` as the adjective -** `ZK` for subsequent mentions of zero knowledge and zero-knowledge on the same page -* Do not end bullet points with any punctuation, such as bullet points or semi-colons (most of the time) + * `zero knowledge` as the noun + * `zero-knowledge` as the adjective + * `ZK` for subsequent mentions of zero knowledge and zero-knowledge on the same page +* Do not end bullet points with any punctuation, such as periods or semi-colons (most of the time) * Use numbered bullets when the order is important, such as steps in a guide or hierarchies of dependencies * Write with [active voice](https://www.grammarly.com/blog/active-vs-passive-voice/) in tutorials and how-tos, and passive voice in explanations * Use the [Oxford comma](https://www.grammarly.com/blog/what-is-the-oxford-comma-and-why-do-people-care-so-much-about-it/)