gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved types and updated documentation (#71)

Browse Source 
* v1.0.0-alpha44
This commit is contained in:
Daniel Lautzenheiser
2022-11-07 10:27:58 -05:00
committed by GitHub
parent ba1cde4e01
commit c55d1f912f
91 changed files with 3695 additions and 2546 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/docs/writing-style-guide.mdx
View File

@ -154,7 +154,7 @@ Exception: Use passive voice if active voice leads to an awkward construction.
### Use simple and direct language
Use simple and direct language. Avoid using unnecessary phrases, such as saying “please.”
Use simple and direct language. Avoid using unnecessary phrases, such as saying "please."
> Do: To create an entry, …
@ -170,7 +170,7 @@ _____
> Don't: With this next command, we'll view the fields.
### Address the reader as “you”
### Address the reader as "you"
> Do: You can create a Deployment by …
@ -195,13 +195,13 @@ _____
> Don't: i.e., …
_____
Exception: Use “etc.” for et cetera.
Exception: Use "etc." for et cetera.
## Patterns to avoid
### Avoid using “we”
### Avoid using "we"
Using “we” in a sentence can be confusing, because the reader might not know whether they're part of the “we” you're describing.
Using "we" in a sentence can be confusing, because the reader might not know whether they're part of the "we" you're describing.
> Do: Version 1.4 includes …
@ -236,7 +236,7 @@ Avoid making promises or giving hints about the future. If you need to talk abou
### Avoid statements that will soon be out of date
Avoid words like “currently” and “new.” A feature that is new today will not be new in a few months.
Avoid words like "currently" and "new." A feature that is new today will not be new in a few months.
> Do: In version 1.4, …