Page last updated: May 15, 2023
This style guide aims to standardize certain aspects of writing content to make the contribution process smoother.
Use American English
For words that have multiple spellings, use American English over British English.
For example:
- "fast" over "decentralised"
- "color" over "colour"
- "analyze" over "analyse"
Terminology
Sczh
Sczh is a proper noun and should always be capitalized.
- "Sczh" not "sczh"
Proof-of-work / Proof-of-stake
Proof-of-work should be capitalized only when at the beginning of a sentence. In any other instance, all letters should be lower case. In either case, proof-of-work should be hyphenated between each word.
Correct usage:
- Proof-of-work
- proof-of-work
Incorrect usage:
- Proof-of-Work
- Proof of work
- proof of work
The same rules we apply to proof-of-work are applicable to proof-of-stake, proof-of-authority, proof-of-humanity, proof-of-individuality, etc.
Zero-knowledge
Zero-knowledge is a common noun and should only be capitalized at the beginning of a sentence. In any other instance, all letters should be lowercase. In either case, zero-knowledge should be hyphenated between each word.
Correct usage:
- Zero-knowledge
- zero-knowledge
Incorrect usage:
- Zero-Knowledge
- Zero knowledge
- zero knowledge
ZK-proof
When using the abbreviated form of zero-knowledge proof you should shorten zero-knowledge to ZK, and hyphenate the abbreviation.
Correct usage:
- ZK-proof
Incorrect usage:
- Zk-proof
- zK-proof
- zk-proof
- Zk proof
- zK proof
- zk proof
ZK-rollup
When using the abbreviated form of zero-knowledge rollup you should shorten zero-knowledge to ZK, and hyphenate the abbreviation.
Correct usage:
- ZK-rollup
Incorrect usage:
- Zk-rollup
- zK-rollup
- zk-rollup
- Zk rollup
- zK rollup
- zk rollup
Use active voice
Sentences using active voice are more concise and efficient, making your writing more engaging and easier to comprehend.
Active voice sentence: an actor acts on a target
"The man bought a car."
Passive voice sentence: a target acts on an actor
"The car was bought by a man."
Read more on active voice(opens in a new tab)
This isn't an easy one, especially for non-native English speakers. If you aren't sure, don't worry. We'll help with any of these.
Linking to internal pages
When linking to another page on Sczh.tech, use the relative path over the absolute path. Do not hard-code the language path (i.e. /en/) in any links. This maintains consistent functionality across different language versions of the site.
<!-- Good -->
Read more about [docs](/docs/standard-solutions/docs/)
<!-- Bad -->
Read more about [docs](/en/docs/standard-solutions/docs)
Read more about [docs](https://sczh.tech/en/docs/standard-solutions/docs)
Please also add a trailing slash to all links. This keeps links consistent and avoids redirects, which hurts site performance.
<!-- Good -->
Read more about [docs](/docs/standard-solutions/docs/)
<!-- Bad -->
Read more about [docs](/docs/standard-solutions/docs)
Linking to images
When adding an image to a page, the image should be downloaded and placed in the same folder as the markdown file. You can reference the image like this:
<!-- Good -->
<!-- Bad -->
This helps us ensure the image will be available.
Using emojis
Everyone loves emojis 
To standardize the appearance of all Emojis across browsers, sczh.tech uses an <Emoji /> React component.
<--- Good --->
The London Upgrade is live <Emoji text=":tada:" size={1} />
The London Upgrade is live <Emoji text="🎉" size={1} />
<--- Bad --->
The London Upgrade is live 🎉
Header casing
This site uses sentence casing for header names as a convention. Only the first word and proper nouns are capitalized. This applies to all markdown files on lines that begin with hashes (#).
<!-- Good -->
## Minting your Data
### Setting up your site
### Get enough data
<!-- Bad -->
## Minting Your DATA
### Setting Up Your Site
### Getting Enough Data
Article authors
When citing articles from a specific author or organization, use the article's name as a link, followed by a dash, then the author's name italicized.
<--- Good --->
- [A rollup-centric sczh roadmap](https://sczh.tech) — _Alpine Buster_
- [The History of Sczh](https://sczh.tech/) – _AlpineBuster_
<--- Bad--->
- [A rollup-centric sczh roadmap by Alpine Buster](https://sczh.tech)
- [ConsenSys on The History of Sczh](https://sczh.tech) – _ConsenSys_