docs: updated style guide (#6910)

pages/docs/docs-style-guide.mdx

@@ -1,113 +1,74 @@
 import DocsLayout from "@components/layouts/DocsLayout.js";
 import Link from "@components/Link";
 
-## About this guide
+## Style Guide
 
-Since our community consists of people from diverse areas of expertise within tech and other industries, we decided to create a simple, straightforward style guide that everyone can use. Below are the four sections that our guide will focus on:
+### Inclusive Language
 
-- [Inclusive Language](#inclusive-language)
-- [Grammar \& Mechanics](#grammar--mechanics)
-- [Clarity](#clarity)
-- [Accessibility](#accessibility)
+Where possible use gender-neutral language.
 
-## Inclusive Language
+For example:
 
-1. Use gender-neutral words for common terms.
+> - **Recommended:** A maintainer should try to be kind yet constructive in **their** feedback.
+> - **Not recommended:** A maintainer should try to be kind yet constructive in **his** feedback.
 
-   **Example:** 
-    - **Not this:** A maintainer should try to be kind yet constructive in **his** feedback.
-    - **Use this:** A maintainer should try to be kind yet constructive in **their** feedback.
+Avoid terms which may have offensive connotations.
 
-2. Avoid using terms that have colonialist or racist connotations.
+For example:
 
-   **Example:** 
-   - **Not this:** Contributors should push their pull requests to the **master** branch.
-   - **Use this:** Contributors should push their pull requests to the **main** branch.
+> - **Recommended:** Contributors should push their Pull Requests to the **main** branch.
+> - **Not recommended:** Contributors should push their Pull Requests to the **master** branch.
 
-## Grammar & Mechanics
+### Grammar & Punctuation
 
-### Commas
+#### Capitalisation
 
-1. Use commas when describing lists.
+Use uppercase to describe a product, a feature, the first letter of a sentence, or a person's name.
 
-   **Example:** 
-   - **Not this:** You can also add your **timeline testimonials and upcoming events** that you are participating in.
-   - **Use this:** You can also add your **timeline, testimonials, and upcoming events** that you are participating in.
+For example:
 
-2. Use commas in introductory elements.
+> - **Recommended:** We suggest you may want to look at our **Contributing** guide on **GitHub**.
+> - **Not recommended:** We suggest you may want to look at our **contributing** guide on **github**.
 
-   **Example:** 
-   - **Not this:** **If you do not have one yet** you can create one for free with an email address and password.
-   - **Use this:** **If you do not have one yet,** you can create one for free with an email address and password.
+### Clarity
 
-3. Use commas before the seven coordinating conjunctions (and, but, so, for, nor, yet, or) to separate two independent clauses.
+#### Abbreviations
 
-   **Example:** 
-   - **Not this:** There are 4 ways you can add your profile **but** for this Quickstart we will use the GitHub UI.
-   - **Use this:** There are 4 ways you can add your profile, **but** for this Quickstart we will use the GitHub UI.
+Do not assume that everyone understands abbreviations, always spell out the full term.
 
-### Capitalisation
+For example:
 
-1. Only capitalise terms that describe a product, its feature, the first letter of a sentence, or a person's name.
+> - **Recommended:** I will merge your **Pull Request**.
+> - **Not recommended:** I will merge your **PR**.
 
-   **Example:** 
-    - **Not this:** There are 4 ways you can add your profile but for this **quickstart** we will use the **github ui**.
-    - **Use this:** There are 4 ways you can add your profile, but for this Quickstart we will use the **GitHub UI**.
+### Accessibility
 
-## Clarity
+#### Images
 
-### Active vs. Passive
+Use Alternative Text to describe images (Alt Text).
 
-1. Remember how your writing instructor has often discouraged you from writing in the passive voice? Well, we need to make sure that contributors fully understand how to contribute to Linkfree, so it would be best to use active voice when working on our documentation.
+#### Emojis
 
-   **Example:** 
-    - **Not this:** Gitpod **was** an open-source application that provides a prebuilt development environment in your browser - powered by VS Code.
-    - **Use this:** Gitpod **is** an open-source application that provides a prebuilt development environment in your browser - powered by VS Code.
-
-### Jargon
-
-1. Since members of EddieHub tend to be new to open-source contributions, it would be best to use technical jargon sporadically so that they can gain a better understanding of how to contribute to Linkfree.
-
-   **Example:** 
-    - **Not this:** Gitpod **was** an open-source application that provides a prebuilt development environment in your browser - powered by VS Code.
-    - **Use this:** Gitpod **is** an open-source application that provides a prebuilt development environment in your browser - powered by VS Code.
-
-## Accessibility
-
-### Bullet points
-
-1. Avoid describing things by their colour or position. Instead, use hyperlinks or figure numbers.
+1. Avoid using emojis as bullet points or numbered lists.
 
-   **Example:** 
-    - **Not this:** See the **image above**.
-    - **Use this:** See **Image 2.2.**
+For example:
 
-### Emojis
+**Not this:**
 
-1. Avoid using emojis as bullet points or numbered lists.
+> - 1️⃣ Fork the repo
+> - 2️⃣ Visit the LinkFree repo
 
-   **Example:** 
-   - **Not this:** \
-   1️⃣ Fork the repo. \
-   2️⃣ Visit the LinkFree repo.
+**Use this:**
 
-   - **Use this:** \
- **1.** Fork the repo. \
- **2️.** Visit the LinkFree repo.
+> - **1.** Fork the repo
+> - **2️.** Visit the LinkFree repo
 
 2. Avoid using emojis in the middle of a sentence.
 
-   **Example:** 
-    - **Not this:** There are 4️⃣ ways you can add your profile, but for this Quickstart we will use the GitHub UI.
-    - **Use this:** There are **4** ways you can add your profile, but for this Quickstart we will use the GitHub UI.
-
-3. Use them sparingly at the end of a sentence.
-
-   **Example:** 
-    - **Not this:** Join the conversation on our Discord community! 😀
-    - **Use this:** Join the conversation on our Discord community!
+   For example:
 
-Have some ideas on improving the guide? Contact us at [Eddiehub](https://github.com/EddieHubCommunity). We’d love to receive your feedback!
+   - **Not this:** There are 4️⃣ ways you can run the project
+   - **Use this:** There are **4** ways you can run the project
 
 export default ({ children }) => (
   <DocsLayout title="LinkFree Style Guide">{children}</DocsLayout>