Improve Lawnchair Documentation v3

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
 

CONTRIBUTING.md

@@ -2,29 +2,33 @@
 
 <picture>
     <!-- Avoid image being clickable with slight workaround --->
-    <source media="(prefers-color-scheme: dark)" srcset="docs/lawnchair-round.webp" width="100">
-    <img alt="" src="docs/lawnchair-round.webp" width="100">
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/lawnchair-round.webp" width="100">
+    <img alt="" src="docs/assets/lawnchair-round.webp" width="100">
 </picture>
 
 First and foremost, welcome to the **Lawnchair** Contributing Guidelines!
 
 ### 💫 Bug reports & feature requests
 
-For bug reports, please describe the bug in detail to the best of your ability
-and steps on how to reproduce it. If applicable, attach log files.
+> [!TIP]
+> 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 feature requests, please describe the feature you'd like to see added to 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
+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 (refer to 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
 
 For translation, visit [Lawnchair on Crowdin](https://lawnchair.crowdin.com) and follow these tips:
 
 -   When using quotation marks, insert the symbols specific to the target language, as listed in this [this summary table](https://en.wikipedia.org/wiki/Quotation_mark#Summary_table);
 -   Some English terminology may have not have commonly-used equivalents in other languages. In such cases, use short descriptive phrases—for example, the equivalent of _bottom row_ for _dock_;
--   Some languages (e.g. French) have variations of words depending if it's masculine or feminine (gender-specific); we recommend opting for gender-neutral words instead.
+-   Some languages (e.g. French) have variations of words depending on if it's masculine or feminine (gender-specific); we recommend opting for gender-neutral words instead.
 
 ### 🧑‍💻 Code
 
@@ -53,6 +57,7 @@ Here are some contribution tips to help you get started:
 
 #### Additional documentation
 
+-   Lawnchair Visual Guidelines ([README.md](/docs/assets/README.md))
 -   Lawnchair Quickstep Compat Lib ([README.md](compatLib/README.md))
 -   Lawnchair Preferences Components ([README.md](lawnchair/src/app/lawnchair/ui/preferences/components/README.md))
 -   SystemUI ViewCapture ([README.md](systemUIViewCapture/README.md))
@@ -62,33 +67,40 @@ 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 separated by four parts:
+Lawnchair’s version code is composed of four parts, separated by underscores:
 
 <p align="center">
     <picture>
-        <source media="(prefers-color-scheme: dark)" srcset="docs/version-dark.svg" width="98%">
-        <img alt="" src="docs/version-light.svg" width="98%">
+        <source media="(prefers-color-scheme: dark)" srcset="docs/assets/version-dark.svg" width="98%">
+        <img alt="" src="docs/assets/version-light.svg" width="98%">
         <!-- Direct the accessibility reader to read the point below --->
     </picture>
 </p>
 
-1. Android's major version
-2. Android's minor version
-3. Lawnchair's development status
-4. Lawnchair's 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 was built from.
+They make up the first two parts of the version code:
 
-##### Android's major & minor versions
+-   Major Version: Indicates the main Android version.
+-   Minor Version: Reflects any point release or update within the major version.
 
-These make up the first two parts of the version code.
-For example: Android 11 will be `11_00_XX_XX` while Android 12.1 will be `12_01_XX_XX`.
+Example: Android 11 will be `11_00_XX_XX` while Android 12.1 will be `12_01_XX_XX`.
 
 ##### Development status & version
 
-The third part of the version code indicates Lawnchair's stability status, while the fourth part indicates the version number.
+The third and fourth parts of the version code refer to Lawnchair's development stage
+and the specific version within that stage:
 
-For example, Alpha 4's version code will be `XX_XX_01_04`.
+-   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.
 
-See the table below detailing the release type:
+The table below shows release phase used by Lawnchair:
 
 | Status            | Stage |
 | ----------------- | ----- |
@@ -97,15 +109,18 @@ See the table below detailing the release type:
 | Release Candidate | 03    |
 | Release           | 04    |
 
+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                                                                      |

LICENSE.txt

@@ -1,6 +1,6 @@
 
    Copyright (c) 2005-2008, The Android Open Source Project
-   Copyright (c) 2023, Lawnchair
+   Copyright (c) 2024, Lawnchair
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -7,10 +7,13 @@
 [![Discord](https://img.shields.io/discord/803299970169700402?label=server&logo=discord)](https://discord.gg/3x8qNWxgGZ)
 
 <picture>
-    <!-- Avoid image being clickable with slight workaround --->
-    <!-- ❤️ Credit to Raine on the Lawnchair Discord --->
-    <source media="(prefers-color-scheme: dark)" srcset="docs/device-frame.png" width="250px">
-    <img alt="Google Pixel running Lawnchair Launcher with green wallpaper" src="docs/device-frame.png" width="250px">
+    <!-- Avoid image being clickable with slight workaround -->
+    <!-- ❤️ Credit to Raine for the original mockup on the Lawnchair Discord -->
+    <!-- ❤️ Credit to Lawrence Kayku for the current mockup on Unsplash 
+            https://unsplash.com/photos/photography-of-green-leaves-ZVKr8wADhpc 
+    -->
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/device-frame.png" width="250px">
+    <img alt="Google Pixel running Lawnchair Launcher with green wallpaper" src="docs/assets/device-frame.png" width="250px">
 </picture>
 
 Lawnchair is a free, open-source home app for Android. Taking Launcher3 — Android’s default home app — as a starting point, it ports Pixel Launcher features and introduces rich options for customization.
@@ -28,8 +31,8 @@ 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
-beta build. For development builds with new icons, use the nightly builds.
+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
 
@@ -38,7 +41,7 @@ Please visit the [Lawnchair Contributing Guidelines](CONTRIBUTING.md) for inform
 ## Quick links
 
 -   [News](https://t.me/lawnchairci)
--   [Lawnchair on Twitter](https://twitter.com/lawnchairapp)
+-   [Lawnchair on X (formerly Twitter)](https://x.com/lawnchairapp)
 -   [Website](https://lawnchair.app)
 -   [_XDA_ thread](https://forum.xda-developers.com/t/lawnchair-customizable-pixel-launcher.3627137/)
 

SECURITY.md

@@ -3,13 +3,14 @@
 ## Supported Versions
 
 > [!WARNING]
-> Lawnchair v2 (Play Store version) is **unsupported**. Use the newer alphas 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.
 
 | Version        | Supported          |
 | -------------- | ------------------ |
+| Nightly build  | :white_check_mark: |
 | 14             | :white_check_mark: |
 | 13             | :x:                |
 | 12.1           | :x:                |

build.gradle

@@ -101,7 +101,7 @@ allprojects {
         compileOnlyCommonJars = {
             dependencies {
                 compileOnly fileTree(dir: FRAMEWORK_PREBUILTS_DIR, include: 'SystemUI-core.jar')
-                compileOnly fileTree(dir: FRAMEWORK_PREBUILTS_DIR, include: 'SystemUI-statsd.jar')
+                compileOnly fileTree(dir: FRAMEWORK_PREBUILTS_DIR, include: 'SystemUI-statsd-14.jar')
                 compileOnly fileTree(dir: FRAMEWORK_PREBUILTS_DIR, include: 'WindowManager-Shell-14.jar')
 
                 compileOnly projects.compatLib

docs/assets/README.md

@@ -0,0 +1,16 @@
+# Lawnchair Visual Guidelines
+
+This directory lists all the decoration & visual explainers used in the Lawnchair Documentation.
+
+All assets created should use the color listed in [CSS](css/) and the [Inter](https://fonts.google.com/specimen/Inter) ([OFL v1.1](https://github.com/rsms/inter/?tab=OFL-1.1-1-ov-file#readme)) typography.
+
+When creating device mockups for Lawnchair, make sure that you're using the latest commits of Lawnchair or use Lawnchair Nightly as base.
+
+## Device Mockup
+
+Use in: [README](/README.md)
+
+* Icon pack: [Lawnicons](https://github.com/LawnchairLauncher/lawnicons)
+* Wallpaper: https://unsplash.com/photos/photography-of-green-leaves-ZVKr8wADhpc
+* Color Extraction Technique: Tonal Spot from Lawnchair
+* License: https://unsplash.com/license

docs/assets/css/dark-hc.css

@@ -0,0 +1,55 @@
+.dark-high-contrast {
+  --md-sys-color-primary: rgb(240 255 237);
+  --md-sys-color-surface-tint: rgb(155 212 160);
+  --md-sys-color-on-primary: rgb(0 0 0);
+  --md-sys-color-primary-container: rgb(159 216 164);
+  --md-sys-color-on-primary-container: rgb(0 0 0);
+  --md-sys-color-secondary: rgb(240 255 237);
+  --md-sys-color-on-secondary: rgb(0 0 0);
+  --md-sys-color-secondary-container: rgb(188 208 186);
+  --md-sys-color-on-secondary-container: rgb(0 0 0);
+  --md-sys-color-tertiary: rgb(242 253 255);
+  --md-sys-color-on-tertiary: rgb(0 0 0);
+  --md-sys-color-tertiary-container: rgb(165 210 219);
+  --md-sys-color-on-tertiary-container: rgb(0 0 0);
+  --md-sys-color-error: rgb(255 249 249);
+  --md-sys-color-on-error: rgb(0 0 0);
+  --md-sys-color-error-container: rgb(255 186 177);
+  --md-sys-color-on-error-container: rgb(0 0 0);
+  --md-sys-color-background: rgb(16 21 16);
+  --md-sys-color-on-background: rgb(224 228 220);
+  --md-sys-color-surface: rgb(16 21 16);
+  --md-sys-color-on-surface: rgb(255 255 255);
+  --md-sys-color-surface-variant: rgb(65 73 65);
+  --md-sys-color-on-surface-variant: rgb(246 253 241);
+  --md-sys-color-outline: rgb(197 205 194);
+  --md-sys-color-outline-variant: rgb(197 205 194);
+  --md-sys-color-shadow: rgb(0 0 0);
+  --md-sys-color-scrim: rgb(0 0 0);
+  --md-sys-color-inverse-surface: rgb(224 228 220);
+  --md-sys-color-inverse-on-surface: rgb(0 0 0);
+  --md-sys-color-inverse-primary: rgb(0 50 18);
+  --md-sys-color-primary-fixed: rgb(187 245 191);
+  --md-sys-color-on-primary-fixed: rgb(0 0 0);
+  --md-sys-color-primary-fixed-dim: rgb(159 216 164);
+  --md-sys-color-on-primary-fixed-variant: rgb(0 27 7);
+  --md-sys-color-secondary-fixed: rgb(216 236 213);
+  --md-sys-color-on-secondary-fixed: rgb(0 0 0);
+  --md-sys-color-secondary-fixed-dim: rgb(188 208 186);
+  --md-sys-color-on-secondary-fixed-variant: rgb(9 26 12);
+  --md-sys-color-tertiary-fixed: rgb(193 239 248);
+  --md-sys-color-on-tertiary-fixed: rgb(0 0 0);
+  --md-sys-color-tertiary-fixed-dim: rgb(165 210 219);
+  --md-sys-color-on-tertiary-fixed-variant: rgb(0 26 30);
+  --md-sys-color-surface-dim: rgb(16 21 16);
+  --md-sys-color-surface-bright: rgb(54 58 53);
+  --md-sys-color-surface-container-lowest: rgb(11 15 11);
+  --md-sys-color-surface-container-low: rgb(24 29 24);
+  --md-sys-color-surface-container: rgb(28 33 28);
+  --md-sys-color-surface-container-high: rgb(38 43 38);
+  --md-sys-color-surface-container-highest: rgb(49 54 48);
+  --md-extended-color-custom-color1-color: rgb(255 249 248);
+  --md-extended-color-custom-color1-on-color: rgb(0 0 0);
+  --md-extended-color-custom-color1-color-container: rgb(255 188 156);
+  --md-extended-color-custom-color1-on-color-container: rgb(0 0 0);
+}