Skip to content

Commit

Permalink
chore: Update starknet_docs_style_guide.adoc (#1161)
Browse files Browse the repository at this point in the history
* Update starknet_docs_style_guide.adoc

* Update starknet_docs_style_guide.adoc

* Update contributing_to_docs/starknet_docs_style_guide.adoc
  • Loading branch information
stoobie authored Mar 10, 2024
1 parent 8791616 commit c806eff
Showing 1 changed file with 60 additions and 3 deletions.
63 changes: 60 additions & 3 deletions contributing_to_docs/starknet_docs_style_guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Starknet documentation supplementary style guide
:toc: macro
:title: Starknet documentation supplementary style guide
:description: Style guidance for writing Starknet technical documentation.
:description: Style guidance for writing Starknet technical documentation

This guide provides style guidelines and preferred term usage for link:https://starknet.io/[the Starknet website], including link:http://docs.starknet.io[docs.starknet.io]. Use it as a supplement to the following style guides:

Expand Down Expand Up @@ -99,6 +99,8 @@ A hyperlink to a page on a third-party website is convenient and user-friendly _

Deprecated:: Refers to a feature or capability that is still supported, but support will be removed in a future release of Starknet.
Future fixes or enhancements are unlikely. If necessary, an alternative is available.
Fri:: The smallest unit of the Starknet native token, STRK, equal to 10^-18^ STRK.
G-fri:: 1,000,000,000 fries.
Removed:: Refers to a feature or capability that has been entirely removed.
Unsupported:: Refers to a feature or capability that is no longer supported.

Expand All @@ -110,6 +112,57 @@ If a term doesn't appear here, refer to the following guides, in order:
. link:https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions[Glossary of terms and conventions] in the _Red Hat supplementary style guide for product documentation_.
. link:https://developers.google.com/style/word-list[Word list] in the _Google developer documentation style guide_.

[#E]
=== E

==== EIP-_<num>_

*Correct form:* EIP-_<num>_

*Example:* EIP-4844

*Incorrect forms:* EIP4844, EIP 4844

*Reasoning:* Align with notation on ethereum.org.

[#F]
=== F

==== fri (10^-18^ STRK)

===== Correct forms

* *Singular:* Fri
* *Plural:* Fries

===== Usage rule

Normal word casing, so use _Fri_ at the beginning of a sentence, and _fri_ after the first word of a sentence.

===== Examples

* Alice holds 5 million fries.
* Fri is the smallest unit of STRK.

[#G]
=== G

==== G-fri (1,000,000,000 fries)

===== Correct forms

* *Singular:* G-fri
* *Plural:* G-fries

===== Usage rule

Normal word casing, so use _G-fri_ at the beginning of a sentence, and _g-fri_ after the first word of a sentence.

===== Examples

* Alice holds 5 million g-fries.
* G-fri is a unit that is equal to one billion fries.

[#O]
=== O

Expand All @@ -136,6 +189,10 @@ If a term doesn't appear here, refer to the following guides, in order:

==== transaction

The default is to use the full word _transaction_ in normal text. You can use _tx_ as an abbreviation for the word _transaction_ if it improves readability.
*Correct form:* transaction, transactions

*Avoid:* tx, txs

Use the full word _transaction_ in normal text. Avoid using the abbreviation _tx_ unless using it improves the user experience.

*Reasoning:* This abbreviation is well known in the industry.
*Reasoning:* Although this abbreviation is well known in the industry, we avoid abbreviations. Abbreviations present a barrier to first-time readers and can also interfere with localization.

0 comments on commit c806eff

Please sign in to comment.