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

Feat: documentation
Some checks failed
Deploy Website / deploy (push) Failing after 4m50s
Details

Browse Source
This commit is contained in:
Raphaël Forment
2026-02-16 23:19:06 +01:00
parent 37f5f74ec1
commit 2d8abe4af9
18 changed files with 565 additions and 227 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,40 +1,50 @@
# Navigation
The Cagire application is organized as a grid composed of six views:
The first thing you need to know is how to navigate in the application. Cagire's interface is organized as a 3x2 grid. There are six views in total:
```
Dict Patterns Options
Help Sequencer Engine
Dict Patterns Options
Help Sequencer Engine
```
- `Dict` (Dictionary): A comprehensive list of all the `Forth` words used in the application.
- `Help`: Provides detailed information about the application's features and functionalities.
- `Patterns`: Pattern banks and pattern manager. Used to organize a session / project.
- `Sequencer`: The main view, where you edit sequences and play music.
- `Options`: Configuration settings for the application.
- `Engine`: Configuration settings for the internal audio 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 appears briefly showing your position in the grid.
Use `Ctrl+Arrow` keys to move between views. A minimap will briefly appear to show your position in the grid. You can also click at the bottom left on the view name to open the switch view panel.
- `Ctrl+Left` / `Ctrl+Right` - move horizontally
- `Ctrl+Up` / `Ctrl+Down` - move vertically
- `Ctrl+Left` / `Ctrl+Right` — move horizontally (wraps around)
- `Ctrl+Up` / `Ctrl+Down` — move vertically (does not wrap)
- `Click` at bottom left — select a view
The grid wraps horizontally, so you can cycle through views on the same row.
You can also jump directly to any view with F-keys:
## Getting Help
Press `?` on any view to see its keybindings. This shows all available shortcuts for the current context.
Press `Esc` to close the keybindings panel.
| Key | View |
|------|------------|
| `F1` | Dict |
| `F2` | Patterns |
| `F3` | Options |
| `F4` | Help |
| `F5` | Sequencer |
| `F6` | Engine |
## Common Keys
These work on most views:
These shortcuts work on every view:
- `Arrow keys` - move or scroll
- `Tab` - switch focus between panels
- `/` or `Ctrl+f` - search (where available)
- `:` - jump to step number (sequencer view)
- `q` - quit (with confirmation)
| Key | Action |
|---------|---------------------------|
| `Space` | Toggle play / stop |
| `q` | Quit |
| `s` | Save project |
| `l` | Load project |
| `?` | Show keybindings for view |
## Getting Help
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.