Skip to content

Point release links to the releases pages #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
morganvenable merged 1 commit into from
Oct 20, 2026
Merged

Point release links to the releases pages #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions src/content/docs/build/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ import finished from '../../../assets/build/finished-svalboard.jpg';
import kitPhoto from '../../../assets/build/kit-hardware-photo.jpg';
import CadFigure from '../../../components/CadFigure.astro';
import YouTube from '../../../components/YouTube.astro';
import facts from '../../../data/facts.json';
export const stable = facts.firmware.stable;
export const blank = (side) => stable.assets.find((a) => a.startsWith(`svalboard_${side}_blank_`) && a.endsWith('.uf2'));
export const blankUrl = (side) => `https://github.com/svalboard/qmk/releases/download/${stable.tag}/${blank(side)}`;

<div class="opening-pair">
<figure class="opening-fig">
Expand Down Expand Up @@ -597,7 +593,7 @@ Test each cluster before final assembly. A bad PCBA is much easier to swap now.
Use the **blank** firmware for this test. No key does anything, so the Matrix Tester shows exactly which switches register.

1. Connect the cluster FFCs to the MCU: unlatch, insert contacts down, latch.
2. Download the blank file for that side from the {stable.tag} release: <a href={blankUrl('left')}><code>{blank('left')}</code></a> or <a href={blankUrl('right')}><code>{blank('right')}</code></a>. Every file is listed in [Firmware files](/firmware/#firmware-files).
2. Download the blank file for that side from the [latest release](https://github.com/svalboard/qmk/releases): `svalboard_left_blank_<release>.uf2` or `svalboard_right_blank_<release>.uf2`. Every file is listed in [Firmware files](/firmware/#firmware-files).
3. Flash it to the MCU. For how, see [Step 15](/build/#step-15-flash-firmware-and-connect) and [Flashing firmware](/firmware/#flashing-firmware).
4. Open [Keybard](/keybard/) (https://keybard.svalboard.com), choose **Connect Keyboard**, then **Matrix Tester**.
5. Press every key on the cluster. Check that each one lights up in the Matrix Tester.
Expand Down Expand Up @@ -943,7 +939,7 @@ Your MCUs ship with **no firmware**, and they aren't set to left or right. Flash

Svalboard runs **Svalboard QMK**, configured with **Keybard**.

1. Go to the latest release: https://github.com/svalboard/qmk/releases/latest
1. Go to the latest release: https://github.com/svalboard/qmk/releases
2. Download one `sval` `.uf2` file for each half. Pick by side, and by the pointing device on that half (none, trackball, TrackPoint or touchpad). The full list of files is in [Firmware files](/firmware/#firmware-files).

- Use the newest release, and the same release on both halves.
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/firmware/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ New microcontrollers, in a kit or as spares, ship with no firmware and are not s

## What's new compared with Vial

Svalboard QMK is the current firmware, `svalboard/qmk`, release **vLaunch2**. You configure it with [Keybard](/keybard/) in Chrome or Edge.
Svalboard QMK is the current firmware, `svalboard/qmk`. Get the [latest release](https://github.com/svalboard/qmk/releases), and configure it with [Keybard](/keybard/) in Chrome or Edge.

Already in Svalboard's Vial firmware, now edited in Keybard:

Expand Down Expand Up @@ -55,7 +55,7 @@ To move your board over, see [Moving from Vial](/firmware/#moving-from-vial).

## Firmware files

Download from the [vLaunch2 release](https://github.com/svalboard/qmk/releases/tag/vLaunch2). Pick one file per half, by the module on that half:
Download from the [latest release](https://github.com/svalboard/qmk/releases). Pick one file per half, by the module on that half. The names below are from vLaunch2; each release puts its own tag at the end.

| Module on that half | Left | Right |
| --- | --- | --- |
Expand All @@ -76,7 +76,7 @@ Flash as in [Flashing firmware](/firmware/#flashing-firmware). Flashing resets y
- **"Your keyboard can't save changes"**: export your current work, unplug the board, plug it back in, reconnect and make the change again.
- **After any reset**: restart the board before making new edits.
- **Keybard won't connect**: use Chrome or Edge, a USB data cable, and close other configuration apps. On Linux, add the udev rule (see [Linux: the udev rule](/firmware/#linux-the-udev-rule)).
- **Board won't start or a half is stuck**: reflash both halves with matching vLaunch2 files (see [Flashing firmware](/firmware/#flashing-firmware)), then import your `.svil`.
- **Board won't start or a half is stuck**: reflash both halves with files from the same release (see [Flashing firmware](/firmware/#flashing-firmware)), then import your `.svil`.

For hardware problems, see [Troubleshooting](/hardware/#troubleshooting).

Expand Down Expand Up @@ -121,7 +121,7 @@ The firmware does **not** bring your Vial settings across. Flashing resets the b

1. In Vial, save your layout as a `.vil`. Keep it unchanged.
2. Write down anything you rely on that a `.vil` doesn't hold: DPI, scrolling, automouse and layer colors (see [What a .vil doesn't hold](/firmware/#what-a-vil-doesnt-hold)).
3. Flash both halves with the vLaunch2 files (see [Firmware files](/firmware/#firmware-files) and [Flashing firmware](/firmware/#flashing-firmware)).
3. Flash both halves with the latest Svalboard QMK files (see [Firmware files](/firmware/#firmware-files) and [Flashing firmware](/firmware/#flashing-firmware)).
4. Open https://keybard.svalboard.com in Chrome or Edge and choose **Connect Keyboard**.
5. Choose **Import Layout** and pick your `.vil`. Read the review, then apply it. This restores your layout, macros, tap dances, combos, key overrides and QMK settings.
6. Set DPI, scrolling, automouse and layer colors again in Keybard.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/keybard/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ Keybard Overlay is a portable ZIP for 64-bit Windows 10 and 11. It isn't signed,

{/* VERIFY: the vLaunch2.3 release ships a portable ZIP (RELEASE-NOTES.md, HOST_DOWNLOAD in HostInstall.tsx). The repo also has a Windows installer build. Should these docs describe an installer instead? */}

1. In Keybard, choose **Overlay**, then **Download for Windows**. Or download the Windows ZIP from the [latest Keybard Overlay release](https://github.com/svalboard/keybard/releases/latest).
1. In Keybard, choose **Overlay**, then **Download for Windows**. Or download the Windows ZIP from the [latest Keybard Overlay release](https://github.com/svalboard/keybard/releases).
2. Extract the whole ZIP to a folder you'll keep. Run **Start-Windows.cmd**.
3. The first start downloads its own copy of Python and Qt, so you need to be online. It needs no administrator rights and makes no system changes.
4. Keybard Overlay sits in the system tray and opens Keybard.
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/start/which-firmware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Svalboard boards run one of two firmwares. Svalboard QMK, configured with Keybar

| | Svalboard QMK (current) | Svalboard's Vial firmware |
| --- | --- | --- |
| Firmware | `svalboard/qmk` release vLaunch2 | `svalboard/vial-qmk` release v2025-11-01 |
| File names | `..._sval_vLaunch2.uf2` | `..._vial_v2025-11-01.uf2` |
| Firmware | `svalboard/qmk`, latest release | `svalboard/vial-qmk` release v2025-11-01 |
| File names | `..._sval_<release>.uf2` | `..._vial_v2025-11-01.uf2` |
| Configure with | Keybard: https://keybard.svalboard.com | Vial (https://vial.rocks or the desktop app), or the Keybard for Vial boards |
| Layout backup file | `.svil` | `.vil` |

Expand All @@ -23,7 +23,7 @@ Open https://keybard.svalboard.com in Chrome or Edge and choose **Connect Keyboa

## Svalboard QMK and Keybard

Svalboard QMK is the current firmware, `svalboard/qmk`, release **vLaunch2**. You configure it with **Keybard** in your browser. The keyboard stores and runs your setup, so you can close Keybard and keep typing.
Svalboard QMK is the current firmware, `svalboard/qmk`. Get the [latest release](https://github.com/svalboard/qmk/releases), and configure it with **Keybard** in your browser. The keyboard stores and runs your setup, so you can close Keybard and keep typing.

Open Keybard at https://keybard.svalboard.com.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/vial/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Current Keybard doesn't edit Vial boards. When it sees Vial firmware, it shows *

## Vial firmware files

Download from the [v2025-11-01 release](https://github.com/svalboard/vial-qmk/releases/tag/v2025-11-01). Pick one file per half, by the module on that half:
Download the v2025-11-01 files from [Vial firmware releases](https://github.com/svalboard/vial-qmk/releases). Pick one file per half, by the module on that half:

| Module on that half | Left | Right |
| --- | --- | --- |
Expand Down
Loading