Skip to content

Commit 8c2186e

Browse files
committed
Updated sleex docs
1 parent 3fac0e1 commit 8c2186e

File tree

2 files changed

+54
-20
lines changed

2 files changed

+54
-20
lines changed

public/assets/sleex/dash.mp4

6.99 MB
Binary file not shown.

src/content/docs/guides/sleex.md

Lines changed: 54 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: The third desktop environement for AxOS.
55

66
![Sleex](/docs/assets/sleex.png)
77

8-
Sleex (based on Hyprland) is the third desktop environment for AxOS. It is the most aesthetic and feature-rich desktop environment of the 3. It has a lot of features, smooth animations and a lot of cool stuff.
8+
Sleex (based on the Hyprland compositor) is the third desktop environment for AxOS. It is the most aesthetic and feature-rich desktop environment of the 3. It has a lot of features, smooth animations and a lot of cool stuff.
99

1010
In this page, you will learn how to use Sleex, how to customize it and how to fix some common issues.
1111

@@ -14,16 +14,16 @@ In this page, you will learn how to use Sleex, how to customize it and how to fi
1414
Your browser does not support the video tag.
1515
</video>
1616

17+
*This video shows an older version of Sleex. The current version may look a bit different (I can't make a new video at every commit).*
18+
1719
## Installation
1820

1921
When installing AxOS, you can choose Sleex as your desktop environment. If you didn't choose it during the installation, you can install it by running the following command:
2022

2123
```bash
2224
epsi i sleex
2325
```
24-
2526
or
26-
2727
```bash
2828
epsi install sleex
2929
```
@@ -35,7 +35,7 @@ You can also install it with pacman.
3535

3636
## Keybinds
3737

38-
Like Calla, it is a tiling window manager, so you can manage your windows with a keyboard. It is also better if used with keybindings, so you can manage your windows with a keyboard. You can find them by pressing `Super + F1`. If you need, you can add keybinds in the `~/.config/hypr/custom/keybinds.conf` file. The configuration method can be found in the [Hyprland documentation](https://wiki.hyprland.org/Configuring/Binds/)
38+
Sleex is a tiling window manager, so it is recommended to use it with a keyboard. You can find every keybinds by pressing `Super + F1`. If you need, you can add keybinds in the `~/.config/hypr/custom/keybinds.conf` file. The configuration method can be found in the [Hyprland documentation](https://wiki.hyprland.org/Configuring/Binds/)
3939

4040
## Widgets
4141

@@ -45,11 +45,13 @@ Sleex has a built-in widget system. You can add, remove and change the code of t
4545

4646
The bar is the top bar of Sleex. Several modules can be found on it.
4747

48-
<video autoPlay muted loop playsInline>
48+
<video autoPlay muted loop playsInline controls>
4949
<source src="/docs/assets/sleex/bar.mp4" type="video/mp4" />
5050
Your browser is from 1998 and doesn't support video.
5151
</video>
5252

53+
*The current version may look a bit different (I can't make a new video at every commit).*
54+
5355
- The title module, named spaceleft shows the process's title (big and white) and the process class/id (small and grey). Scroll on it to change the screen brightness.
5456
- The resources module shows the current usage of CPU, SWAP and RAM. If the percentage is over 90%, it turns orange.
5557
- The Workspace module shows the workspaces, if they're used and the primary app of each. It can be customized in the settings app to show numbers, show the icons, and others.
@@ -61,11 +63,13 @@ The bar is the top bar of Sleex. Several modules can be found on it.
6163

6264
The dashboard is a widget with several modules. You can open it by clicking on the right side of the bar, or by pressing `Super + D`.
6365

64-
<video autoPlay muted loop playsInline>
66+
<video autoPlay muted loop playsInline controls>
6567
<source src="/docs/assets/sleex/dash.mp4" type="video/mp4" />
6668
Your browser is from 1998 and doesn't support video.
6769
</video>
6870

71+
*The current version may look a bit different (I can't make a new video at every commit).*
72+
6973
#### Home tab
7074
In the home tab, you will find simple display elements:
7175
- **User greeting**, because we are polite. You must set the profile icon in the settings app.
@@ -77,70 +81,100 @@ In the home tab, you will find simple display elements:
7781
- **Calendar** that doesn't do much...
7882

7983
#### Todo tab
80-
It's a simple todo list, nothing more nothing less
84+
It's a simple todo list, nothing more nothing less.
8185

82-
### AI panel
86+
You can add tasks, mark them as done, delete them, move them up and down etc. The tasks are saved in `.sleex/user/todo.json`.
8387

84-
The AI panel (called sidebarLeft) is a panel where you can use LLMs **with your API keys**.
88+
#### AI assistant
8589

86-
*Note: Sleex is not affiliated with any of the providers included in the sidebarLeft.*
90+
The AI assistant is a tab where you can use LLMs **with your API keys**.
8791

88-
<video autoPlay muted loop playsInline>
89-
<source src="/docs/assets/sleex/sidebarleft.mp4" type="video/mp4" />
90-
Your browser is from 1998 and doesn't support video.
91-
</video>
92+
*Note: Sleex is not affiliated with any of the model providers included in the AI assistant.*
93+
94+
Some commands are available to make your experience better:
95+
- Type `/model` to select a model. Locally installed Ollama models are detected automatically.
96+
- Type `/key` for instructions on how to get an API key for online models.
97+
98+
Currently, Gemini models with tools can edit your shell config or execute commands (with your confirmation). you can for example ask it increase or decrease your brightness.
99+
100+
#### Agenda (or Calendar) tab
101+
102+
The calendar tab is an interactive calendar where you can add, remove and edit events.
103+
104+
Events are controlled with the `khal` command line tool.
105+
106+
You can enable the remote calendar sync by enabling the `vdirsyncer` option in the settings app. Note that you need to configure `vdirsyncer` manually. You can find a default configuration file at `~/.config/vdirsyncer/config` for Google Agenda sync (not affiliated).
107+
108+
You can find a VDirSyncer configuration tutorial on the [vdirsyncer documentation](https://vdirsyncer.pimutils.org/en/stable/tutorial.html).
92109

93110
### Desktop
94111

95112
On the desktop, you can find:
96113
- A discrete watermark at the bottom right (that can be disabled in the settings app)
97114
- A desktop clock, that can be moved, toggled and themed (dark or light) in the settings app.
115+
- A random quote at the bottom left, that can be toggled in the settings app.
98116

99-
<video autoPlay muted loop playsInline>
117+
<video autoPlay muted loop playsInline controls>
100118
<source src="/docs/assets/sleex/desktop_clock.mp4" type="video/mp4" />
101119
Your browser is from 1998 and doesn't support video.
102120
</video>
103121

122+
*The current version may look a bit different (I can't make a new video at every commit).*
123+
104124
### Dock
105125

106126
The dock is a widget where you can pin apps to access them rapidely.
107127

108128
When an app is open, the icon shows at the right of it. If you right click on it, the app will be pined and will be there even if it is not opened.
109129

110-
<video autoPlay muted loop playsInline>
130+
<video autoPlay muted loop playsInline controls>
111131
<source src="/docs/assets/sleex/dock.mp4" type="video/mp4" />
112132
Your browser is from 1998 and doesn't support video.
113133
</video>
114134

115135

116136
### Overview
117137

118-
The overview is a widget where you can see the current workspaces and the apps of each workspaces.
138+
The overview is a widget where you can see the current workspaces and the apps of each workspaces. You can drag and drop apps between workspaces and close them with middle click.
119139

120140
This widget is also an app launcher. Search for the app you want to open, then press enter or click on it. The search bar is also a calculator, a web search and a convertor.
121141

122-
<video autoPlay muted loop playsInline>
142+
Results can include:
143+
- Apps installed on your system
144+
- Math calculations
145+
- Commands to run in terminal
146+
- Web search
147+
- (prefix with `/`) Launcher actions
148+
- (prefix with `;`) Clipboard history items
149+
- (prefix with `:`) Emojis
150+
151+
<video autoPlay muted loop playsInline controls>
123152
<source src="/docs/assets/sleex/overview.mp4" type="video/mp4" />
124153
Your browser is from 1998 and doesn't support video.
125154
</video>
126155

156+
*The current version may look a bit different (I can't make a new video at every commit).*
157+
127158
### Settings
128159

129160
The settings app is a primary element of Sleex. On It, you can find multiple tabs with different functions:
130-
- The **Appearence** tab is to configure simple elements such as the wallpaper, the color scheme and the light/dark mode.
161+
- The **Style** tab is to configure simple elements such as the wallpaper, the color scheme and the light/dark mode.
131162
- The **Interface** tab is to configure the sleex shell elements.
132163
- The **Behavior** tab is to configure some shell backend / system elements.
133164
- The **Sound** tab is to configure audio inputs/outputs.
134165
- The **Bluetooth** tab is to configure bluetooth and connect devices.
135166
- The **Wifi** tab is to configure wifi.
136167
- The **Display** tab is to configure displays.
168+
- The **Privacy** tab is to configure privacy-related options such as location services, AI policy etc.
137169
- The **About** tab contains basic infos about AxOS and Sleex.
138170

139-
<video autoPlay muted loop playsInline>
171+
<video autoPlay muted loop playsInline controls>
140172
<source src="/docs/assets/sleex/settings.mp4" type="video/mp4" />
141173
Your browser is from 1998 and doesn't support video.
142174
</video>
143175

176+
*The current version may look a bit different (I can't make a new video at every commit).*
177+
144178

145179
## Developers
146180

0 commit comments

Comments
 (0)