Skip to content

Commit

Permalink
feat(docs): Meta doc typo fixes (#4779)
Browse files Browse the repository at this point in the history
Please read [contributing guidelines](CONTRIBUTING.md) and remove this
line.
  • Loading branch information
catmcgee authored Feb 27, 2024
1 parent 48dd78e commit 44df132
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/HOW_WE_WRITE_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down

0 comments on commit 44df132

Please sign in to comment.