Style guide #232
Style guide #232
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
| - Do not use "once" to mean "after," as in "Once the system shuts down, you can safely remove the drive." | ||
|
|
||
| - Avoid Latinate abbreviations like e.g. and i.e. |
There was a problem hiding this comment.
Because it's clearer writing style to not use such abbreviations. "For example" is clearer than "e.g." and "i.e." usually doesn't provide a clear connection between two thoughts.
|
We could enrich this guide with pragmatic rules, such as: in the beginning of each tutorial, clearly mention what versions are used for each tool involved. This ensures more robustness in time. Or maybe this is not a style issue? |
Co-authored-by: NicNomadic <[email protected]>
Yes, that could be good follow-up: standards for tutorials, diagrams, code samples, descriptions of tools and programs, and page structure. |
Style guide for Tezos docs based on things I've observed. Very open to suggestions here.
This guide does not take a stance on US English vs. British English. en_US is more popular but en_GB would be fine because TriliTech is a British-based company.
Preview: https://docs-staging-git-style-guide-trili-tech.vercel.app/reference/style-guide