Review docs, format with prettier

LawnchairLauncher · Aug 14, 2024 · 2c26e64 · 2c26e64
1 parent db38424
commit 2c26e64
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 35 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people.
-* Being respectful of differing opinions, viewpoints, and experiences.
-* Giving and gracefully accepting constructive feedback.
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience.
-* Focusing on what is best not just for us as individuals, but for the
-  overall community.
+-   Demonstrating empathy and kindness toward other people.
+-   Being respectful of differing opinions, viewpoints, and experiences.
+-   Giving and gracefully accepting constructive feedback.
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience.
+-   Focusing on what is best not just for us as individuals, but for the
+    overall community.
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind.
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment.
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission.
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting.
+-   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind.
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment.
+-   Publishing others' private information, such as a physical or email
+    address, without their explicit permission.
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting.
 
 ## Enforcement Responsibilities
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,16 +11,16 @@ First and foremost, welcome to the **Lawnchair** Contributing Guidelines!
 ### 💫 Bug reports & feature requests
 
 > [!TIP]
-> We recommend that Lawnchair [Nightly](https://github.com/LawnchairLauncher/lawnchair/releases/tag/nightly) 
-> build should be use in your report as they contain the latest changes from Lawnchair.
+> We recommend that the Lawnchair [Nightly](https://github.com/LawnchairLauncher/lawnchair/releases/tag/nightly)
+> build be used in your report as they contain the latest changes from Lawnchair.
 
 For [bug reports](https://github.com/LawnchairLauncher/lawnchair/issues/new?assignees=&labels=bug&projects=&template=bug_report.yaml&title=%5BBUG%5D+), please describe the bug in detail to the best of your ability
-and steps on how to reproduce it. If applicable, attach log files.
+with steps on how to reproduce it. If applicable, attach log files.
 
 For [feature requests](https://github.com/LawnchairLauncher/lawnchair/issues/new?assignees=&labels=feature%2Cenhancement&projects=&template=feature_request.yaml&title=%5BFEATURE%5D+), please describe the feature you'd like to see added to Lawnchair.
 If applicable, attach log files.
 
-Please make sure to be civil during discussion of your contribution as outlined by the [Code of Conduct](CODE_OF_CONDUCT.md).
+Please make sure to be civil during the discussion of your contribution as outlined by the [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ### 🌐 Translation
 
@@ -67,7 +67,7 @@ Here are some contribution tips to help you get started:
 #### Versioning scheme
 
 As of [#4361](https://github.com/LawnchairLauncher/lawnchair/pull/4361),
-Lawnchair’s version code is composed by four parts separated by underscores:
+Lawnchair’s version code is composed of four parts, separated by underscores:
 
 <p align="center">
     <picture>
@@ -77,28 +77,28 @@ Lawnchair’s version code is composed by four parts separated by underscores:
     </picture>
 </p>
 
-1. Android Major Version
-2. Android Minor Version
-3. Lawnchair Development Status
-4. Lawnchair Development Version
+1. Android major version
+2. Android minor version
+3. Lawnchair development status
+4. Lawnchair development version
 
 ##### Android major & minor versions
 
-These represent the Android version the Lawnchair launcher is built from. 
+These represent the Android version the Lawnchair Launcher was built from.
 They make up the first two parts of the version code:
 
-* Major Version: Indicates the main Android version.
-* Minor Version: Reflects any point release or update within the major version.
+-   Major Version: Indicates the main Android version.
+-   Minor Version: Reflects any point release or update within the major version.
 
 Example: Android 11 will be `11_00_XX_XX` while Android 12.1 will be `12_01_XX_XX`.
 
 ##### Development status & version
 
-The third and fourth parts of the version code refer to Lawnchair's development stage 
+The third and fourth parts of the version code refer to Lawnchair's development stage
 and the specific version within that stage:
 
-* Development Status: Shows the current phase of the Lawnchair build (e.g., Alpha, Beta).
-* Development Version: Specifies the incremental version within the same development stage.
+-   Development Status: Shows the current phase of the Lawnchair build (e.g., Alpha, Beta).
+-   Development Version: Specifies the incremental version within the same development stage.
 
 The table below shows release phase used by Lawnchair:
 
@@ -109,18 +109,18 @@ The table below shows release phase used by Lawnchair:
 | Release Candidate | 03    |
 | Release           | 04    |
 
-Example: Alpha 5 will be `XX_XX_01_05` and Beta 3 will be `XX_XX_02_03`.
+Example: alpha 5 will be `XX_XX_01_05` and beta 3 will be `XX_XX_02_03`.
 
 #### String naming
 
 Strings `names` in `strings.xml` should follow this format:
 
 | Type                                             | Format            | Example usage              | Actual string        | Other information                                                                                                   |
-|--------------------------------------------------|-------------------|----------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------|
+| ------------------------------------------------ | ----------------- | -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------- |
 | Generic word                                     | $1                | `disagree_or_agree`        | Disagree or agree    | Should only be used if it doesn't fit the below categories                                                          |
 | Action                                           | $1_action         | `apply_action`             | Apply                | Any generic action verb can fit here                                                                                |
 | Preference or popup label<br/>Preference headers | $1_label          | `folders_label`            | Folders              |                                                                                                                     |
 | Preference or popup description                  | $1_description    | `folders_description`      | Row and column count |                                                                                                                     |
 | Preference choice                                | $1_choice         | `off_choice`               | Off                  |                                                                                                                     |
-| Feature string                                   | (feature_name)_$1 | `colorpicker_hsb`          | HSB                  | Feature strings are strings that are confined to a specific feature. Examples include the gesture and color picker. |
+| Feature string                                   | (feature*name)*$1 | `colorpicker_hsb`          | HSB                  | Feature strings are strings that are confined to a specific feature. Examples include the gesture and color picker. |
 | Launcher string                                  | $1_launcher       | `device_contacts_launcher` | Contacts from device | Strings that are specific to the Launcher area                                                                      |
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ This branch houses the codebase of Lawnchair 14, which is currently in beta and
 
 ## Download
 
-See the [Releases](https://github.com/LawnchairLauncher/lawnchair/releases) section for the latest
+See the [releases](https://github.com/LawnchairLauncher/lawnchair/releases) section for the latest
 beta build. For development builds with upcoming features & bug fixes, use the nightly builds.
 
 ## Contributing

diff --git a/SECURITY.md b/SECURITY.md
@@ -3,7 +3,7 @@
 ## Supported Versions
 
 > [!WARNING]
-> Lawnchair v2 (Play Store version) is **unsupported**. Use the newer version instead.
+> Lawnchair v2 (Play Store version) is **unsupported**. Use the newer versions instead.
 > See [this FAQ page](https://lawnchair.app/faq#do-you-still-support-the-play-store-version) for additional information.
 
 The latest version of Lawnchair is the only supported version.