Adapt content from Status style guide

docs-standards/10-structure-the-content/01-document-types/concept-help-me-to-understand.md

@@ -30,7 +30,7 @@ Check out the [file names and location rules](../../../CONTRIBUTING.md#file-name
 ### General rules
 
 - Target for documents between 900 and 1 500 words. Split longer ideas into separate concept topics.
-- Replace dense prose with [lists](../../20-style-the-content/06-bullet-lists.md) and [tables](../../20-style-the-content/08-tables.md) to improve readability.
+- Replace dense prose with [lists](../../20-style-the-content/06-bullet-lists.md) and [tables](../../20-style-the-content/09-tables.md) to improve readability.
 - Richly [link](../../20-style-the-content/10-links.md) to related topics, especially procedure and reference topics.
 - Include [diagrams or images](../../30-work-with-media/_index.md) to illustrate complex ideas or workflows.
 

docs-standards/20-style-the-content/02-capitalization.md

@@ -0,0 +1,19 @@
+# Capitalization
+
+- Use sentence-style capitalization, including titles. That means everything is lowercase except the first word, proper nouns, like the Status product names.
+
+    | Usage       | Example                       |
+    |:------------|:------------------------------|
+    | **Correct** | Configure system admin access |
+    | Incorrect   | Configure System Admin Access |
+
+- Don't capitalize words after colons, except when these words are proper nouns, acronyms, or bullet list items.
+
+    | Usage       | Example                                                                                                                                         |
+    |:------------|:------------------------------------------------------------------------------------------------------------------------------------------------|
+    | **Correct** | You can run the command-line application in several ways: using the binary, using Docker, or running as a service in Linux.                     |
+    | Incorrect   | You can run the command-line application in several ways: Using the binary, using Docker, or running as a service in Linux.                     |
+    | **Correct** | You can run the command-line application in several ways:<br>- Use the binary.<br>- Use Docker.<br>- Run as a service in Linux.                 |
+    | Incorrect   | You can run the command-line application in several ways:<br>- use the binary<br>- use Docker<br>- run as a service in Linux.                   |
+    | **Correct** | Many digital currencies use the ERC-20 standard: Status (STN), Basic Attention Token (BAT), MakerDAO (DAI), and others.                         |
+

docs-standards/20-style-the-content/03-titles.md

@@ -0,0 +1,27 @@
+# Titles
+
+- Use the rules described in the [Structure the content](../10-structure-the-content/_index.md) section for each document type.
+- Use meaningful titles that provide a precise idea of the article's content.
+
+    | Usage     | Example |
+    |:----------|:--------|
+    | **Correct** | Upload a file using Codex  |
+    | Incorrect   | Upload a file    |
+    | Incorrect   | Uploading a file using Codex   |
+
+- Adhere to the capitalization convention described in this article.
+- Your article's title determines the Markdown file name:
+    - Use the article's title in all-lowercase letters for the Markdown file name.
+    - Use a dash symbol ("-") to replace spaces.
+    - Don't exclude articles, prepositions, or any other word in the Markdown file name.
+    - If the name includes apostrophes, remove them from the Markdown file name. If the apostrophe is part of the possesive form with an extra *s* letter, separate the letter in the name (example: `transfer-you-community-s-ownership`).
+
+    | Usage       | Article name                              | .md file name                           |
+    |:------------|:------------------------------------------|:----------------------------------------|
+    | **Correct** | Upload a file using Codex                 | upload-a-file-using-codex.md            |
+    | **Correct** | Transfer your community's ownership       | transfer-your-community-s-ownership.md  |
+    | Incorrect   | Transfer your community's ownership       | transfer-your-communitys-ownership.md   |
+    | Incorrect   | Browse people and Communities in Status   | Browse-people-and-Communities-in-Status.md |
+    | Incorrect   | Browse people and Communities in Status   | browse-people-communities-status.md     |
+    | **Correct** | FAQ: Import data from Discord             | faq-import-data-from-discord.md         |
+    | **Correct** | Do's and don'ts of Profile security       | dos-and-donts-of-profile-security.md    |

docs-standards/20-style-the-content/04-sentences-and-paragraphs.md

@@ -0,0 +1,35 @@
+# Sentences and paragraphs
+
+- Write sentences of a maximum of 25 words and paragraphs of no more than 50-60 words. Rewrite the content and break sentences and paragraphs as necessary.
+- Include *the* and *that* to clarify your sentence.
+
+    | Usage      | Example                                         |
+    |:-----------|:------------------------------------------------|
+    | **Correct**   | Identify the chart settings that affect the layout.   |
+    | Incorrect  | Identify chart settings affecting the layout.           |
+    | **Correct**   | The database that is online syncs every 30 seconds.  |
+    | Incorrect  | The online database syncs every 30 seconds.             |
+
+- Don't use sentence connectors: *So*, *Thus*, *Therefore*, *Consequently*, *As a consequence*, *For this reason*, *Hence*, and so on.
+
+    | Usage      | Example                                                                 |
+    |:-----------|:------------------------------------------------------------------------|
+    | **Correct**   | Your seed phrase provides access to your crypto assets. Keep your seed phrase safe. |
+    | Incorrect  | Your seed phrase provides access to your crypto assets. Therefore, keep your seed phrase safe. |
+
+- Avoid long [noun phrases](https://en.wikipedia.org/wiki/Noun_phrase). If you use a noun phrase, don't use more than one modifier. Use the *of* preposition to simplify noun phrases.
+
+    | Usage      | Example                                      |
+    |:-----------|:---------------------------------------------|
+    | **Correct**   | The default lifetime of a token value is one year. |
+    | Incorrect  | The default token value lifetime is one year.         |
+
+- Keep adjectives and adverbs immediately before the word they modify. Pay close attention to *only* and *not*.
+
+    | Usage      | Example                                 |
+    |:-----------|:----------------------------------------|
+    | **Correct**   | You can access your messages only after 30 days. |
+    | Incorrect  | You can only access your messages after 30 days.    |
+
+- In the first paragraph after a heading, avoid repeating the title information. For example, if the heading title is "Search for a contact using the Status display name," don't start the first paragraph with "To search for a contact using the Status display name [...]"
+- Lookup for instances of the *which* word on your text; it's possible you can replace them with *that*. For more information about the differences between *which* and *that*, check out this [Grammarly article](https://www.grammarly.com/blog/which-vs-that/).

docs-standards/20-style-the-content/05-punctuation-and-symbols.md

@@ -0,0 +1,26 @@
+# Punctuation and symbols
+
+- Avoid. Unnecessary. Punctuation.
+- Use these guidelines for commas:
+    - Use commas to separate main clauses.
+    - Use a comma before *such as*.
+    - Use a comma after *for example*.
+    - Use the Oxford comma for *and* and *or* conjunctions where the meaning of your sentence would otherwise be unclear. In other cases, avoid placing the extra comma.
+    - In procedural steps, don't write a comma in sentences such as *click on cancel, and then...*
+- Use these guidelines for periods:
+    - Use a period at the end of a sentence, including sentences ending on a [URL](./links.mdx).
+    - Observe the punctuation rules for items on a [bullet list](./bullet-lists.mdx).
+    - Observe the punctuation rules for items on a [table](./tables.mdx).
+- Don't use semicolons. Instead, use a period and write the text after the semicolon in a new sentence.
+- Avoid preceding tables with colons. Instead, use a period.
+- Don't use dashes (_em_ or _en_ dashes.) Instead, use parenthesis if you need to clarify information.
+- Use parenthesis sparingly, and don't write essential information inside parenthesis.
+- Don't use bold or italics with punctuation symbols.
+- When you must use quotes, use double straight quotes. Don't use quotes with user interface elements.
+- Observe the [bullet lists](./06-bullet-lists.md) punctuation rules.
+- To spell out symbols and punctuations marks, use the [List of typographical symbols and punctuation marks](https://en.wikipedia.org/wiki/List_of_typographical_symbols_and_punctuation_marks) article from Wikipedia.
+
+    | Usage       | Example                                                       |
+    |:------------|:--------------------------------------------------------------|
+    | **Correct** | To quote text inline, use the greater-than sign (`>`) before your text.  |
+    | Incorrect   | To quote text inline, use the bigger-than sign (`>`) before your text.  |

docs-standards/20-style-the-content/06-bullet-lists.md

@@ -0,0 +1,28 @@
+# Bullet lists
+
+- Don't use a bullet list for actions that users should complete in an orderly manner; use numbered lists in procedures.
+- Use a bullet list to improve the readability of sentences or paragraphs where you list or describe three or more items.
+
+    | Usage      | Example                                                                                           |
+    |:------------|:---------------------------------------------------------------------------------------------------|
+    | **Correct**| You need a machine running Ubuntu Linux with the following minimum requirements:<br>- 4 GB memory<br>- 2 TB SSD<br>- Linux 64-bit |
+    | Incorrect  | You need a machine running Ubuntu Linux with the following minimum requirements: 4 GB memory, 2 TB SSD, and Linux 64-bit. |
+    | Incorrect  | You need a machine with 4 GB of memory, a 2 TB SSD, and a 64-bit Ubuntu Linux operating system.  |
+
+- Use a colon (:) before the bullet list items.
+- Use periods at the end of each sentence in a bullet list for [punctuation](./05-punctuation-and-symbols.md). Using periods on a bullet list can be tricky. Use the following guidelines:
+    - When the list items are complete sentences, use a period at the end of each sentence.
+    - Don't use a period when the list items are not complete sentences or sentences with three words or less.
+    - In a list with elements of more and less than three words mixed, don't use a period.
+    - If one item in a column is a complete sentence, all items in that column should end with a period, even if they are a single word.
+- Don't use colons after each item on a list; type the item definition on a new line. Here are some examples of using punctuation on a list:
+
+    | Usage      | Example                                                                 |
+    |:------------|:-------------------------------------------------------------------------|
+    | **Correct** | - **Dependency graph**<br>  A repository graph that shows the packages and projects that the repository depends on.<br>- **Dependents graph**<br>  A repository graph that shows the packages, projects, and repositories that depend on a public repository. |
+    | Incorrect  | - **Dependency graph**:<br>  A repository graph that shows the packages and projects that the repository depends on.<br>- **Dependents graph**:<br>  A repository graph that shows the packages, projects, and repositories that depend on a public repository. |
+    | Incorrect  | - **Dependency graph**: A repository graph that shows the packages and projects that the repository depends on.<br>- **Dependents graph**: A repository graph that shows the packages, projects, and repositories that depend on a public repository. |
+
+> ☝️ **Tip:**
+>
+> When you need to describe each element on a list and you have more than three elements, consider using a table instead.

docs-standards/20-style-the-content/07-numbered-lists.md

@@ -0,0 +1,10 @@
+# Numbered lists
+
+- When reading instructions, users understand numbered lists as actions to complete orderly. Because of this, limit the numbered lists to procedural instructions in procedure topics.
+- If you must use a numbered list outside of a procedure, use the same rules described for bullet lists.
+- Use "1." for all items in a numbered list. This ensures the list renders correctly and simplifies reordering.
+
+    | Usage     | Example |
+    |:----------|:--------|
+    | **Correct** | 1. Open the web page in your browser.<br>1. Click the "Sign In" button.<br>1. Enter your credentials. |
+    | Incorrect   | 1. Open the web page in your browser.<br>2. Click the "Sign In" button.<br>3. Enter your credentials.  |

docs-standards/20-style-the-content/08-checkbox-lists.md

@@ -0,0 +1,6 @@
+# Checkbox lists
+
+If you need to list several actions the user should perform in no particular order, use checkbox lists. For procedural steps, use [numbered-lists](./07-numbered-lists.md).
+
+  ✅ Item 1<br>✅ Item 2<br>✅ Item 3
+

docs-standards/20-style-the-content/09-tables.md

@@ -0,0 +1,39 @@
+# Tables
+
+Tables provide a simple way to summarize information. Use a table instead of [bullet lists](./06-bullet-lists.md) when you need to describe the elements on the list.
+
+- Bullet list example (incorrect):
+
+  There are four types of items:
+
+  - **Item 1** <br>Item 1 description
+  - **Item 2** <br>Item 2 description
+  - **Item 3** <br>Item 3 description
+  - **Item 4** <br>Item 4 description
+
+- Table format example (**correct**):
+
+    | Item   | Description          |
+    |:-------|:---------------------|
+    | Item 1 | Item 1 description |
+    | Item 2 | Item 2 description |
+    | Item 3 | Item 3 description |
+    | Item 4 | Item 4 description |
+
+You can also use tables to compare the available options across different elements.
+
+    | Features   | Desktop | Mobile | Web |
+    |:-----------|:--------|:-------|:----|
+    | Feature A  |   ✅    |   ✅   |     |
+    | Feature B  |   ✅    |        |     |
+    | Feature C  |         |   ✅   | ✅  |
+
+> ☝️ **Tip:**
+>
+> You can use links in tables except if the table is part of a procedure step.
+
+Use the following guidelines when using periods in a table for punctuation:
+
+- End every complete sentence inside tables with a period.
+- Use periods when there are multiple sentences in one table cell.
+- Keep table columns parallel. If one item in a column is a complete sentence, all items in that column should end with a period, even if they are a single word. This rule applies to each column individually, not across the entire table.

docs-standards/20-style-the-content/10-links.md

@@ -0,0 +1,29 @@
+# Links
+
+Use links to other articles in the IFT documentation, but don't abuse links. For example, don't make the topic look like a Wikipedia article with a link in every sentence.
+
+- Limit the links for sources outside the IFT documentation.
+- Don't use links in procedural steps, except when you link to a subtask in the same article.
+- In general, write the link without using the URL. If you must use the URL, omit the `https://` and the `www` parts of the URL (if the website allows this).
+- Don't hide the linked content using the words _here_ or _this_. Instead, write out the content you link.
+
+    | Usage       | Example                       |
+    |:------------|:------------------------------|
+    | **Correct** | For more details about tokens, check out **Understand Status tokens**. |
+    | Incorrect   | For more details about tokens, check out **this** article. |
+
+- When pointing the user to external sources, start you sentence with *For more details*.
+
+    | Usage       | Example                       |
+    |:------------|:------------------------------|
+    | **Correct** | For more details about tokens, check out **Understand Status tokens**. |
+    | **Correct** | For more details, check out **Understand Status tokens**. |
+    | Incorrect   | To learn more about tokens, check out **this** article. |
+
+- For links outside of the IFT documentation site, use the ↗ symbol at the end of the link description.
+
+    | Usage       | Example                       |
+    |:------------|:------------------------------|
+    | **Correct** | See [status.app/features ↗](https://status.app/features). |
+    | Incorrect | [https://status.app/features ↗](https://status.app/features).|
+    | Incorrect   | See 'Safely open apps on your Mac' at [https://support.apple.com/en-us/HT202491](https://support.apple.com/en-us/HT202491). |