Skip to content

Commit 2fb635f

Browse files
committed
fixup! Update docs
1 parent c30fcf9 commit 2fb635f

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

docs/.assets/h_list.png

375 KB
Loading

docs/.assets/tree.png

510 KB
Loading

docs/guide.md

+29-4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
**Table of contents**
44

55
- [Tree](#tree)
6+
- [Layouts](#layouts)
67
- [Normalization](#normalization)
78
- [Floating windows](#floating-windows)
89
- [Default keybindings](#default-keybindings)
@@ -15,10 +16,34 @@
1516
- [Multiple displays](#multiple-displays)
1617

1718
## Tree
18-
TODO DOCUMENTATION. This section is yet to be written, for now you can refer to https://i3wm.org/docs/userguide.html#tree
19+
20+
AeroSpace stores all windows and their layout containers in a tree. AeroSpace tree tiling model is [inspired by
21+
i3](https://i3wm.org/docs/userguide.html#tree).
22+
23+
- Each workspace contains own root node
24+
- Each node can contain arbitrary number of other nodes
25+
- Windows are leaf nodes. Windows can't contain children nodes
26+
- Every non-leaf node has two properties: layout and orientation
27+
28+
When we say layout of the window, we refer to the layout of the window's parent.
29+
30+
It's easier to understand tree tiling model by looking at examples
31+
32+
![](./.assets/h_list.png)
33+
![](./.assets/accordion.png)
34+
35+
### Layouts
36+
37+
AeroSpace provides 4 possible layouts:
38+
- horizontal list (in i3, it's called "horizontal split")
39+
- vertical list (in i3, it's called "vertical split")
40+
- horizontal accordion (analog of i3's "tabbed layout")
41+
- vertical accordion (analog of i3's "stacked layout")
1942

2043
### Normalization
21-
TODO DOCUMENTATION
44+
45+
By default, AeroSpace does two types of normalizations to the tree:
46+
- Containers that have only one child are "flattened".
2247

2348
### Floating windows
2449
TODO DOCUMENTATION
@@ -35,8 +60,8 @@ AeroSpace will read config file from `~/.aerospace.toml`. Please see the followi
3560
- The default config contains all possible keys with comments: [default-config.toml](../config-examples/default-config.toml)
3661
- i3 like config: [i3-like-config-example.toml](../config-examples/i3-like-config-example.toml)
3762

38-
AeroSpace uses TOML format for the config. TOML is a popular format with open specification. TOML is easy to read, and it supports
39-
comments. See [TOML site for more info](https://toml.io/en/)
63+
AeroSpace uses TOML format for the config. TOML is easy to read, and it supports comments. See [TOML site for more
64+
info](https://toml.io/en/)
4065

4166
### Binding modes
4267
TODO DOCUMENTATION

0 commit comments

Comments
 (0)