Extract bos-settings to its own repo; add breadhelp; JSON-driven Hyprland config

bos-settings moves to git.breadway.dev/Breadway/bos-settings (full history
preserved via git-filter-repo) so its release cadence is decoupled from
BOS's own. breadhelp takes its place as this repo's workspace member: a
GTK4 onboarding/help center replacing the old bos-welcome/bos-keybinds
bash scripts with searchable guides, an interactive keybind viewer
(sourced from the new keybinds.toml, not parsed out of hyprland.lua or
hardcoded), a troubleshooting wizard with one-click fixes, and a proper
first-run tour. bos-netcheck extracts bos-welcome's network-check half,
which still needs to run every login independent of breadhelp's own
first-run gating.

hyprland.lua's keybinds/settings/monitors/autostart are now JSON-driven
(binds.json/settings.json/monitors.json/autostart.json) with every
loader pcall-wrapped and falling back to hardcoded defaults per field on
bad or missing config, so bread* apps (bos-settings' new editors, and
breadhelp's keybind viewer) can read/write this config without ever
being able to leave the compositor unable to start.

CI's package.yml now builds breadhelp instead of bos-settings on tag
push; bos-settings needs its own equivalent workflow in its new repo
(not yet set up).
This commit is contained in:
Breadway 2026-07-05 09:16:14 +08:00
parent 434efcea22
commit 664298b6b4
105 changed files with 3280 additions and 5149 deletions

View file

@ -0,0 +1,10 @@
# Welcome!
This computer runs BOS — a friendly desktop built for you.
- Hold down the SUPER key (it looks like a little window logo) and press other keys to do things.
- [Show Keybind]super + /[/Show Keybind] always shows you every shortcut, so you never have to memorize anything.
- [Show Keybind]super + ,[/Show Keybind] opens Settings.
- If anything ever looks wrong, your computer saves a safety copy every time something changes — nothing is ever truly lost.
- [Run]bos-settings|Open Settings[/Run]

View file

@ -0,0 +1,21 @@
# Welcome to BOS
BOS (the Bread Operating System) is a complete Hyprland desktop with the
bread ecosystem preinstalled: a bar, a launcher, notes, Wi-Fi profiles, and a
settings app that needs no config files.
## The basics
- SUPER is the Windows/Cmd key — almost everything starts with it.
- [Show Keybind]super + /[/Show Keybind] shows the full keybind cheatsheet any time.
- [Show Keybind]super + ,[/Show Keybind] opens BOS Settings — configure the bar, launcher, Wi-Fi, notes, snapshots, and package updates all in one place.
- [Show Keybind]super + space[/Show Keybind] opens the app launcher (breadbox).
- [Show Keybind]super + return[/Show Keybind] opens a terminal.
## Safety net
Your system snapshots itself on every package change. If an update breaks
something, roll it back from BOS Settings or pick a snapshot right from the
GRUB menu at boot.
- [Run]bos-settings|Open BOS Settings[/Run]

View file

@ -0,0 +1,5 @@
title = "What is BOS?"
difficulty = "beginner"
tags = ["overview", "welcome"]
related = ["02-essential-keybinds"]
estimated_minutes = 2

View file

@ -0,0 +1,23 @@
# The essential keybinds
Hyprland is keyboard-first. You don't need a mouse for any of this — but
nothing here is mandatory either, click around if you'd rather.
## Windows
- [Show Keybind]super + return[/Show Keybind] opens a terminal
- [Show Keybind]super + backspace[/Show Keybind] closes the focused window
- [Show Keybind]super + f[/Show Keybind] toggles fullscreen
- [Show Keybind]super + i[/Show Keybind] toggles floating
## Apps
- [Show Keybind]super + space[/Show Keybind] opens the launcher (breadbox)
- [Show Keybind]super + e[/Show Keybind] opens files
- [Show Keybind]super + b[/Show Keybind] opens the browser
- [Show Keybind]super + u[/Show Keybind] opens notes
## The full list
The Home tab's keybind viewer always has the complete, current list — this
guide only covers the ones you'll use every day.

View file

@ -0,0 +1,5 @@
title = "The essential keybinds"
difficulty = "beginner"
tags = ["keybinds", "hyprland"]
related = ["01-what-is-bos"]
estimated_minutes = 3

View file

@ -0,0 +1,18 @@
# Personalizing BOS
The whole desktop recolors itself from your wallpaper — bar, launcher,
notes, settings, and this help center all pick up the same palette
automatically.
## Change your wallpaper
- [Run]breadpaper|Open the wallpaper picker[/Run]
Picking a new wallpaper regenerates the color palette for every bread app —
no restart needed, everything live-reloads.
## Change the bar and launcher
Open BOS Settings for per-app options:
- [Run]bos-settings|Open BOS Settings[/Run]

View file

@ -0,0 +1,5 @@
title = "Personalizing BOS"
difficulty = "beginner"
tags = ["wallpaper", "theme", "customization"]
related = []
estimated_minutes = 3