BuboBubo/Cagire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Feat: documentation, UI/UX

Browse Source
This commit is contained in:
Raphaël Forment
2026-03-01 19:09:52 +01:00
parent ecb559e556
commit db44f9b98e
57 changed files with 1531 additions and 615 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/getting-started/navigation.md
View File

@@ -1,41 +1,6 @@
# Navigation
Cagire's interface is organized as a 3x2 grid of six views:
```
Dict Patterns Options
Help Sequencer Engine
```
- *Dict* : Forth dictionary — learn about the language.
- *Help* : Help and tutorials — learn about the tool.
- *Patterns* : Manage your current session / project.
- *Sequencer* : The main view, where you edit sequences and play music.
- *Options* : Configuration settings for the application.
- *Engine* : Configuration settings for the audio engine.
## Switching Views
Use `Ctrl+Arrow` keys to move between views. A minimap will briefly appear to show your position in the grid. You can also click on the view name at the bottom left to open the switch view panel.
- `Ctrl+Left` / `Ctrl+Right` — move horizontally (wraps around)
- `Ctrl+Up` / `Ctrl+Down` — move vertically (does not wrap)
- `Click` at bottom left — select a view
You can also jump directly to any view with the F-keys:
| Key | View |
|------|------------|
| `F1` | Dict |
| `F2` | Patterns |
| `F3` | Options |
| `F4` | Help |
| `F5` | Sequencer |
| `F6` | Engine |
## Common Keys
These shortcuts work on every view:
Press `?` on any view to see its keybindings. The most important shortcuts are always displayed in the footer bar. Press `Esc` to close the keybindings panel. These shortcuts work on every view:
| Key | Action |
|---------|---------------------------|
@@ -45,6 +10,29 @@ These shortcuts work on every view:
| `l` | Load project |
| `?` | Show keybindings for view |
## Getting Help
## Views
Press `?` on any view to see the associated keybindings. This shows all available shortcuts for the current context. The most important keybindings are displayed in the footer bar. Press `Esc` to close the keybindings panel.
Cagire's interface is organized as a 3x2 grid of six views. Jump to any view with its F-key or `Ctrl+Arrow` keys:
```
F1 Dict F2 Patterns F3 Options
F4 Help F5 Sequencer F6 Engine
```
| Key | View | Description |
|------|------------|-------------|
| `F1` | Dict | Forth dictionary — learn about the language |
| `F2` | Patterns | Manage your current session / project |
| `F3` | Options | Configuration settings for the application |
| `F4` | Help | Help and tutorials — learn about the tool |
| `F5` | Sequencer | The main view, where you edit sequences and play music |
| `F6` | Engine | Configuration settings for the audio engine |
Use `Ctrl+Arrow` keys to move between adjacent views. A minimap will briefly appear to show your position in the grid. You can also click on the view name at the bottom left or in the top left corner of the header bar to open the switch view panel.
- `Ctrl+Left` / `Ctrl+Right` — move horizontally (wraps around)
- `Ctrl+Up` / `Ctrl+Down` — move vertically (does not wrap)
## Secrets
There is a hidden seventh view: the **Periodic Script**. Press `F11` to open it. The periodic script is a free-running Forth script evaluated at every step, independent of any pattern. It is useful for drones, global effects, control logic, and experimentation. See the **Periodic Script** tutorial for details.