Breadway/breadhelp
1
0
Fork 0
Code Issues 2 Pull requests 1 Projects Releases Packages Wiki Activity Actions 2
Onboarding and help center for BOS
62 commits 5 branches 14 tags 540 KiB
  • Rust 98.7%
  • Shell 1.3%
Find a file
Exact
Breadway 4673e0cbf4
All checks were successful
dev release / build (push) Successful in 2m57s
Details
Merge breadbug guides docs slice (PR 13) 
Partial breadhelp docs slice only. Consent source, settings page and site gates remain open.
2026-10-16 16:49:40 +08:00
.forgejo/workflows CI: remove shared temp cleanup from release workflows 2026-09-30 02:37:07 +08:00
ci ci: make the bread-ecosystem clone in ci/build.sh race-free 2026-09-29 17:46:28 +08:00
content docs: breadbug guides match shipped behavior, gate planned work 2026-10-15 12:19:48 +08:00
packaging docs: remove em dashes from code and docs 2026-09-07 10:06:59 +08:00
src Merge breadbug guides docs slice (PR 13) 2026-10-16 16:49:40 +08:00
.gitignore ci: build dev track and PR checks against dependency main 2026-09-28 06:55:01 +08:00
AGENTS.md docs: remove em dashes from code and docs 2026-09-07 10:06:59 +08:00
bakery.toml Onboard onto bakery: bakery.toml + dev/beta/release CI, relocate content paths 2026-07-23 10:10:30 +08:00
Cargo.lock chore: bump version to 0.2.7 2026-09-11 19:12:54 +08:00
Cargo.toml chore: bump version to 0.2.7 2026-09-11 19:12:54 +08:00
CONTRIBUTING.md ci: build dev track and PR checks against dependency main 2026-09-28 06:55:01 +08:00
EVENTS.md docs: remove em dashes from code and docs 2026-09-07 10:06:59 +08:00
LICENSE Add standalone repo scaffolding (README, packaging, CI) 2026-07-15 19:00:30 +08:00
README.md docs: remove em dashes from code and docs 2026-09-07 10:06:59 +08:00

README.md

breadhelp

Onboarding and help center for BOS (Bread Operating System): GTK4, a searchable guide library, an interactive keybind viewer, a troubleshooting wizard with one-click fixes, a short first-boot day-zero wizard (timezone, network hint, updates, snapper), and a live guided tour overlay that spotlights real on-screen bread* apps (breadbar, breadbox, ...) instead of walking through a static wizard.

Split out of the bos repo into its own repo so a breadhelp release doesn't require a BOS ISO release, and vice versa. A bakery product (bakery.toml + bakery CI) and baked into the BOS ISO, not pacman-packaged.

Building

cargo build --release

Packaging / releasing

See CONTRIBUTING.md for the single-trunk + tag model. main publishes a bakery dev build; a vX.Y.Z-rc.N tag publishes beta; a vX.Y.Z tag publishes stable. The leftover packaging/ tree is not a pacman source; bakery is canonical (see packaging/README.md).

bread event integration

Works the same with or without breadd. When the main window is shown, breadhelp publishes bread.help.opened. See EVENTS.md.