diff --git a/Autocorrect.md b/Autocorrect.md deleted file mode 100644 index 1502626..0000000 --- a/Autocorrect.md +++ /dev/null @@ -1,84 +0,0 @@ -# Autocorrect - -Automatically fixes common typing mistakes in real-time. Uses Pascal Getreuer's [400-entry autocorrection dictionary](https://getreuer.info/posts/keyboards/autocorrection/index.html) for frequently mistyped words, reducing the need for manual backspacing and retyping. - -## How It Works - -The autocorrect feature monitors your keystrokes and automatically replaces common typos as you type. Corrections happen instantly and invisibly. - -## Word-Start Corrections - -Some corrections require a word boundary before them (indicated by `:` prefix). These only trigger at the start of a word: - -| Typo | Correction | -|----------|------------| -| `:htere` | `there` | -| `:thier` | `their` | -| `:hwihc` | `which` | -| `:owudl` | `would` | -| `:htink` | `think` | -| `:goign` | `going` | - -## Common Corrections - -### Frequent Words - -| Typo | Correction | -|------------|------------| -| `abbout` | `about` | -| `abotu` | `about` | -| `woudl` | `would` | -| `coudl` | `could` | -| `shoudl` | `should` | -| `whcih` | `which` | -| `whihc` | `which` | -| `teh` | `the` | - -### Common Mistakes - -| Typo | Correction | -|------------|------------| -| `peaple` | `people` | -| `peopel` | `people` | -| `peolpe` | `people` | -| `becasue` | `because` | -| `becuase` | `because` | -| `beacuse` | `because` | -| `thikn` | `think` | -| `thnigs` | `things` | -| `aroud` | `around` | -| `arround` | `around` | -| `alwasy` | `always` | -| `alwyas` | `always` | -| `anohter` | `another` | -| `beween` | `between` | -| `bewteen` | `between` | - -### Positional Typos - -| Typo | Correction | -|------------|------------| -| `realy` | `really` | -| `raelly` | `really` | -| `littel` | `little` | -| `befoer` | `before` | -| `bedore` | `before` | -| `beeing` | `being` | -| `almsot` | `almost` | -| `chnage` | `change` | -| `chekc` | `check` | -| `childen` | `children` | -| `claer` | `clear` | -| `comapny` | `company` | - -## Examples - -``` -Type: "I htink this is graet" → "I think this is great" -Type: "peaple aroud the world" → "people around the world" -Type: "becuase I shoudl check" → "because I should check" -``` - -## Reference - -For the complete dictionary of all 400 corrections, see our [autocorrect_data.h](../qmk_userspace/features/autocorrect_data.h). diff --git a/Combos.md b/Combos.md deleted file mode 100644 index b237a50..0000000 --- a/Combos.md +++ /dev/null @@ -1,53 +0,0 @@ -# Combos - -Press multiple keys simultaneously to output different characters or trigger actions. Enables access to numbers, symbols, and commands without leaving the home position. - -Inspired by Jonas Hietala's [T-34 keyboard layout](https://www.jonashietala.se/series/t-34/). - -## Vertical Numbers - -Press home row and upper row simultaneously for the column number: - -| Combo | Output | Combo | Output | -|--------------|--------|--------------|--------| -| `W` + `C` | `1` | `Z` + `M` | `6` | -| `L` + `R` | `2` | `F` + `N` | `7` | -| `Y` + `S` | `3` | `O` + `E` | `8` | -| `P` + `T` | `4` | `U` + `I` | `9` | -| `B` + `G` | `5` | `'` + `A` | `0` | - -## Home Row Shortcuts - -### Left Hand - -| Combo | Output | Description | -|--------------|------------------|------------------| -| `R` + `S` | `Tab` | Tab key | -| `S` + `T` | `Ctrl+Backspace` | Delete word | - -### Right Hand - -| Combo | Output | Description | -|--------------|-----------|--------------| -| `N` + `E` | `Escape` | Escape key | -| `E` + `I` | `Enter` | Enter key | - -## Bottom Row Shortcuts - -### Left Hand - -| Combo | Output | Description | -|--------------|------------|---------------------| -| `J` + `V` | `:` | Vim command mode | -| `V` + `D` | `Gui+A` | XMonad prefix | - -### Right Hand - -| Combo | Output | Description | -|--------------|------------|---------------------| -| `H` + `/` | `Alt+A` | WezTerm prefix | -| `/` + `,` | `\` | Escape sequences | - -## Reference - -For the complete implementation, see our [combos.def](../qmk_userspace/keyboards/ferris/sweep/keymaps/sajenim/combos.def). diff --git a/Home.md b/Home.md index 10c54a0..f333cca 100644 --- a/Home.md +++ b/Home.md @@ -1,43 +1,4 @@ -Welcome to the Wiki. +# QMK Userspace Wiki -## Layout - -**[Canary](https://github.com/Apsu/Canary)**
-Community-designed keyboard layout with over 55% rolling trigrams for a flowy typing experience. Emphasizes reduced same-finger bigrams and balanced hand usage. We use the standard Canary layout without modifications. - -## Features - -**[Autocorrect](Autocorrect)**
-Automatically fixes 400+ common typing mistakes in real-time - -**[Combos](Combos)**
-Press multiple keys simultaneously for numbers, symbols, and shortcuts - -**[Repeat and Magic Key](Repeat-and-Magic-Key)**
-Advanced repeat key implementation with intelligent context-aware completions - -## Layers - -**[Colemak Extend](https://colemakmods.github.io/ergonomic-mods/extend.html)** | **[DreymaR](https://dreymar.colemak.org/layers-extend.html)** | **[Seniply](https://stevep99.github.io/seniply/)**
-Our NAV and NUM layers are inspired by Colemak Extend, a navigation and editing layer concept that keeps frequently-used keys accessible from home position. Extend layers provide cursor movement, text editing shortcuts, and number access without reaching for dedicated keys. Our implementation adapts these principles for a split 34-key layout with application-specific modifier positioning. - -**[Symbol Layer](Symbol-Layer)**
-Custom symbol layer optimized for programming with bracket rolls and logical operator placement - -## Home Row Mods - -**[Precondition's Guide](https://precondition.github.io/home-row-mods)**
-Modifier keys (Alt, Shift, GUI, Ctrl) placed on the home row as dual-function keys. Tap for letter, hold for modifier. Reduces finger movement and strain by eliminating reaches to traditional modifier positions. - -### Our Positioning Rationale - -Each modifier is positioned based on its primary application: - -| Modifier | Application | Purpose | -|-----------|-------------|--------------------------------------| -| **GUI** | XMonad | Workspace switching, window management | -| **Alt** | WezTerm | Tab navigation, pane control | -| **Ctrl** | Neovim | Text manipulation, commands | -| **Shift** | - | Chording with other modifiers | - -The NAV and NUM layers duplicate these modifiers on the opposite hand. This creates powerful home row chords: hold a modifier on one hand while accessing navigation keys or numbers on the other. For example, GUI+arrow keys manages XMonad windows, Alt+numbers switches WezTerm tabs, and Ctrl+navigation executes Neovim motions - all without moving from home position. \ No newline at end of file +- [Repeat and Magic Key](Repeat-and-Magic-Key) +- [Symbol Layer](Symbol-Layer) diff --git a/_Sidebar.md b/_Sidebar.md deleted file mode 100644 index 25001bb..0000000 --- a/_Sidebar.md +++ /dev/null @@ -1,16 +0,0 @@ -**[Home](Home)** - -## Layout -- [Canary Layout](https://github.com/Apsu/Canary) -- [Keymap](https://git.sajenim.dev/jasmine/qmk_userspace/src/branch/main/assets/img/keymaps/ferris-sajenim.svg) - -## Layers -- [Symbol Layer](Symbol-Layer) - -## Features -- [Autocorrect](Autocorrect) -- [Combos](Combos) -- [Repeat and Magic Key](Repeat-and-Magic-Key) - -## Home Row Mods -- [Precondition's Guide](https://precondition.github.io/home-row-mods)