feat: improved theom documentation

Byson94 · Byson94 · commit be945a38895a · 2025-09-28T12:37:09.000+05:30
diff --git a/src/content/docs/guides/theom.md b/src/content/docs/guides/theom.md
@@ -3,135 +3,33 @@ title: Theom
 description: The fourth desktop environment of AxOS.
 ---
 
-## Table of Contents
+![Theom](/docs/assets/theom4.png)
 
-1. [Installation](#installation)
+Theom (based on i3wm) is the fourth desktop environment for AxOS. It is mainly focused on asthetics, customization, and low resource usage.
 
-   - [Epsilon Install](#epsilon-install)
-   - [Manual Install](#manual-install)
-
-2. [Default Keybindings](#default-keybindings)
-
-   - [Essentials](#essentials)
-   - [Workspace Management](#workspace-management)
-   - [Window Focus](#window-focus)
-   - [Window Movement](#window-movement)
-   - [Layout](#layout)
-   - [Scratchpad](#scratchpad)
-   - [Resize Mode](#resize-mode)
-
-3. [Configuration](#configuration)
-
-   - [Configuring Theom](#configuring-theom)
-   - [Important Notes](#important-notes)
-   - [Config Structure](#config-structure)
-
-     - [appearance](#appearance)
-     - [bar](#bar)
-     - [widgets](#widgets)
-     - [compositor](#compositor)
-     - [osd](#osd)
-
-   - [Troubleshooting](#troubleshooting)
-
-4. [Keybinding Configuration](#keybinding-configuration)
-
-   - [Getting Started](#getting-started)
-   - [Syntax](#syntax)
-   - [Variables](#variables)
-   - [Reloading](#reloading)
-   - [Recovery](#recovery)
-
-5. [PITFALLS IN THEOM](#pitfalls-in-theom)
+In this section, you will learn how to customize and use Theom.
 
 ## Installation
 
-There are two ways to install Theom: via Epsilon, or manually.
-
-### Epsilon Install
-
-To install using Epsilon, run:
+When installing AxOS, you can choose Theom as your desktop environment. If you didn't choose it during the installation, you can install it by running the following command:
 
 ```bash
-epsi install theom
+epsi i theom
 ```
 
-This will fetch and install the latest version automatically.
-
-### Manual Install
-
-1. Download the latest release from [GitHub Releases](https://github.com/AxOS-project/Theom/releases).
-2. Install the package:
+or
 
 ```bash
-sudo pacman -U <downloaded-file>
+epsi install theom
 ```
 
-Replace `<downloaded-file>` with the actual filename.
-
----
-
-## Default Keybindings
-
-> The `mod` key refers to the **Super (Windows)** key.
-
-### Essentials
-
-- `mod+Return` — Launch terminal (default: Alacritty)
-- `mod+d` — Open application launcher (Rofi)
-- `mod+Shift+d` — Open Theom dashboard
-- `mod+f1` — Open Theom cheatsheet
-- `mod+Shift+q` — Close focused window
-- `mod+f` — Toggle fullscreen
-- `mod+Shift+space` — Toggle floating mode
-- `mod+space` — Switch between tiling and floating
-- `mod+Shift+e` — Exit i3 with confirmation
-- `Print` — Take screenshot with Flameshot
+If you are on some other operating system other than AxOS, read our [Porting to other OS Documentation](https://github.com/AxOS-project/Theom/wiki/Porting-to-other-OS).
 
-### Workspace Management
+## Keybindings
 
-- `mod+1` through `mod+0` — Switch to workspace 1–10
-- `mod+Shift+1` through `mod+Shift+0` — Move window to workspace 1–10
+Just like Sleex and Calla, it is a tiling window manager. So you can control almost everything with your keyboard. You can find all the default keybindings in the cheetsheet which can be opened by pressing `Mod + F1` (Where `mod` being the windows key). If needed, you can even modify/add new keybindings in the `~/.config/theom/keybindings.conf` file. The configuration syntax can be found in the [i3wm Keybinding Documentation](https://i3wm.org/docs/userguide.html#keybindings).
 
-### Window Focus
-
-- `mod+j/k/l/semicolon` — Focus left/down/up/right
-- `mod+Arrow Keys` — Focus in respective direction
-- `mod+a` — Focus parent container
-
-### Window Movement
-
-- `mod+Shift+j/k/l/semicolon` — Move window left/down/up/right
-- `mod+Shift+Arrow Keys` — Move window with arrow keys
-
-### Layout
-
-- `mod+h` — Horizontal split
-- `mod+v` — Vertical split
-- `mod+e` — Toggle split orientation
-- `mod+s` — Stacking layout
-- `mod+w` — Tabbed layout
-
-### Scratchpad
-
-- `mod+minus` — Send window to scratchpad
-- `mod+Shift+minus` — Show first scratchpad window
-
-### Resize Mode
-
-- `mod+r` — Enter resize mode
-
-  - `j/Left` — Shrink width
-  - `k/Down` — Grow height
-  - `l/Up` — Shrink height
-  - `semicolon/Right` — Grow width
-  - `Enter/Escape/mod+r` — Exit resize mode
-
----
-
-## Configuration
-
-### Configuring Theom
+## Configuring Theom
 
 Main configuration file:
 
@@ -145,8 +43,6 @@ This file manages themes, widgets, compositor modes, and more.
 
 > **Do not change the structure**. Only edit **values**. Changing or removing keys like `[appearance]` or `theme = ...` may cause errors.
 
----
-
 ### Config Structure
 
 #### `[appearance]`
@@ -221,8 +117,6 @@ Currently deprecated.
 osd = false
 ```
 
----
-
 ### Troubleshooting
 
 If your config breaks:
@@ -242,86 +136,6 @@ cp /usr/share/theom/config/theom/config.toml ~/.config/theom/
 
 3. Re-login.
 
----
-
-## Keybinding Configuration
-
-### Getting Started
-
-The keybindings config is at:
-
-```bash
-~/.config/theom/keybindings.conf
-```
-
-This file follows the same syntax as i3wm configs.
-
-> **Caution:** This is part of the window manager. Mistakes can prevent access to your desktop.
-
-### Syntax
-
-Each keybinding uses the following format:
-
-```conf
-bindsym <key combo> <action>
-```
-
-Example:
-
-```conf
-bindsym $mod+Return exec alacritty
-```
-
-- `$mod` is defined as a variable, usually `Mod4`.
-- `alacritty` launches the terminal.
-
-#### Variables
-
-Variables improve readability and reuse:
-
-```conf
-set $mod Mod4
-```
-
-Only `$mod` is defined by default. You can add more.
-
-### Reloading
-
-To reload after editing keybindings:
-
-- Run `i3-msg restart`
-- Or press `mod+Shift+r`
-
-### Recovery
-
-If you break it:
-
-1. Try opening a terminal. If that fails, use `Ctrl + Alt + F3`.
-2. Reset keybindings:
-
-```bash
-# Option 1: Auto-regenerate
-rm ~/.config/theom/keybindings.conf
-theom-setup # regenerates the config
-
-# Option 2: Restore default manually
-cp /usr/share/theom/config/theom/keybindings.conf ~/.config/theom/
-```
-
-3. Re-login.
-
----
-
-## PITFALLS IN THEOM
-
-Theom has as a few pitfalls due to it's philosophies.
-
-You can read the common pitfalls in theom at our [GitHub Wiki](https://github.com/AxOS-project/Theom/wiki/Pitfalls-in-Theom).
-
----
-
 <p style="font-size: 0.9em; text-align: center;">
-  Last updated: <strong>2025-06-26</strong> • Theom <strong>v2</strong>
+  Last updated: <strong>2025-09-28</strong> • Theom <strong>v4</strong>
 </p>
-
----
