feat!: rebalance colors, adhere to style guide & overhaul docs (#372)

Option names have been changed to be more intuitive and more closely follow
the tmux naming conventions.

Renamed:
@catppuccin_window_current_background -> @catppuccin_window_current_number_color
@catppuccin_window_current_color      -> @catppuccin_window_current_text_color
@catppuccin_window_default_background -> @catppuccin_window_number_color
@catppuccin_window_default_color      -> @catppuccin_window_text_color

Removed:
@catppuccin_window_default_fill, @catppuccin_window_current_fill
Just set the number and text colors.

Co-authored-by: Hammy <[email protected]>

feat!: rebalance the colors used, and follow the styleguide

fix(tests): add tests for window styling

refactor!: change how windows are styled

feat: rebalance the status module colors for cpu and battery

docs: update the preview images

docs: change the stack style for the preview, add flavor previews

docs: update readme for v2 changes

docs: use a column layout for the preview

docs: add an example of a ram custom module

docs: use markdownlint to check README.md

docs: add a getting started guide

docs: update links in the getting started guide

docs: move the status line docs to the docs dir

docs: add basic demo using vhs

docs: add config reference

docs: move more docs into ./docs/

docs: restructure the docs folder

docs: add design explanation

docs: add the version tag to the manual install instructions

docs: fill out the design philosophy

chore: update issue templates and contributing.md

docs: tidy up docs and add an updated structure image

docs: add instructions for gitmux

docs: add a background to the structure image

docs(CONTRIBUTING.md): add missing `[`

feat!: change how status modules are styled

.github/ISSUE_TEMPLATE/bug.yml

@@ -3,6 +3,13 @@ description: Report your bugs with the theme here!
 labels: [bug]
 body:
   - type: checkboxes
+    attributes:
+      label: I am not requesting help with my configuration and believe something is genuinely broken.
+      description: Please open a [discussion](https://github.com/catppuccin/tmux/discussions/new?category=help) if you need support.
+      options:
+        - label: Something is really actually broken.
+          required: true
+   - type: checkboxes
     attributes:
       label: Is there an existing issue outlining your problem?
       description: Please search to see if an issue already exists for your problem.
@@ -13,20 +20,13 @@ body:
     attributes:
       label: Describe your problem.
       description: Also tell us, what do you expect to see?
-      placeholder: The battery charging icon is missing...
+      placeholder: The status bar is bright green, I expect it to be mantle.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Paste your configuration.
-      description: Provide us with the contents of your `.tmux.conf` file.
-      placeholder: |
-        ```sh
-        set -g @plugin 'catppuccin/tmux'
-        set -g @plugin 'tmux-plugins/tpm'
-        # ...
-        run ~/.config/tmux/tpm/tpm
-        ```
+      description: Provide us with the contents of your `~/.tmux.conf` file.
     validations:
       required: true
   - type: textarea
@@ -37,7 +37,7 @@ body:
     attributes:
       label: What tmux version are you seeing the issue on?
       description: "You can find your version by running `tmux -V`"
-      placeholder: tmux 3.3a
+      placeholder: tmux 3.5a
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Ask A Question
-    url: https://github.com/catppuccin/tmux/discussions/new?category=q-a
+  - name: Get Support
+    url: https://github.com/catppuccin/tmux/discussions/new?category=help
     about: Need help tweaking your Catppuccin tmux configuration? Ask questions in GitHub Discussions!
   - name: Show & Tell
     url: https://github.com/catppuccin/tmux/discussions/new?category=show-tell

.github/release-please-config.json

@@ -8,7 +8,8 @@
       "bump-patch-for-minor-pre-major": false,
       "draft": false,
       "extra-files": [
-        "README.md"
+        "README.md",
+        "docs/tutorials/01-getting-started.md"
       ]
     }
   },

.markdownlint.jsonc

@@ -0,0 +1,15 @@
+{
+    "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.35.0/schema/markdownlint-config-schema.json",
+    "line-length": {
+        "code_block_line_length": 120,
+        "tables": false
+    },
+    "no-inline-html": {
+        "allowed_elements": ["details", "summary", "img", "p", "a", "h3"]
+    },
+    "first-line-heading": false,
+    "no-alt-text": false,
+    "code-block-style": {
+        "style": "consistent"
+    }
+}

CONTRIBUTING.md

@@ -1,9 +1,8 @@
 # Contributing
 
-## Adding a module
+## Design
 
-Follow the instructions from [custom](/custom), place the module in the appropriate
-directory and document the module in `README.md`.
+To understand our mindset in developing this plugin and how to ensure your changes align with that mindset, check out the "[Design Philosophy](./docs/explanation/design.md)."
 
 ## Commit messages
 
@@ -36,7 +35,7 @@ described by Conventional Commits. Use the `<type>!` syntax in order to distingu
 breaking commits in the log, but include the footer to provide a better description
 for the changelog generator.
 
-```
+```text
 feat(bar)!: foo the bars
 
 BREAKING CHANGE: bars are now foo'ed