Commit Graph

4 Commits

Author SHA1 Message Date
MarekZegare4
3113dabd2c docs: rename screenshots to descriptive names
Switch the screenshot convention from positional numbers (tls_scr_8) to
self-documenting names (locator, locator_picker, map_target, …). Names say what
they show, so a shot can be re-captured or inserted without renumbering, and a
reference can't silently point at the wrong image. Per-doc directories keep the
names unambiguous, so no prefix is needed (overview_oled.png lives in each
screen's own folder).

git mv on every existing PNG + ref updates across all six solo_features docs;
the pending placeholders adopt the same scheme.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 18:19:09 +02:00
MarekZegare4
8df289fb16 docs: add screenshot placeholders for un-illustrated screens
Reviewed the user-facing solo_features docs for screens/sub-views described in
prose but never shown, and added placeholder image tables (repo's OLED|E-Ink
convention) with "screenshot pending" capture notes:

- Tools: Live Share, Waypoints navigation view, Add-by-coords form, Compass,
  Diagnostics, Repeater (tls_scr_11..16).
- Settings: Radio preset popup / frequency digit editor (set_scr_3).
- Clock: Dashboard Config (clk_scr_3).
- Favourites Dial: pin-to-dial contact picker (fav_dial_2).

PNGs just need dropping in under the listed names; tables render as broken
images until then (the repo's existing in-progress convention).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 18:11:55 +02:00
Jakub
fb700bbaad docs+ci: pre-merge polish — README, doc accuracy, workflow
README:
- Fix typo "offical" → "official"
- File names in Firmware Variants table now match workflow output
  (solo-<version>-oled.uf2 / solo-<version>-eink.uf2)
- Un-comment the E-ink Display section (now fully supported)
- Clock Screen: "sensor values" → "data fields" (covers Batt%, Nodes, Msgs)
- Tools Screen: mention nearby nodes and auto-advert in the highlight
- Promote Screenshot Tool to its own top-level section (was buried under
  Contributing); fix `uv run tools/screenshot.py` invocation path

Docs:
- favourites_dial: document the 3rd pin-picker tier (all chat contacts
  fallback) added in 0e0e5b93
- clock_screen: Altitude source clarified — onboard sensor (GPS or
  barometric), not always GPS
- message_screen: blank lines around image tables that were inlined

Code:
- UITask.cpp: rename leftover plus_y/plus_label locals to solo_y/solo_label
  in the splash-screen Solo banner

Workflow:
- workflow_dispatch builds previously labelled firmware with the branch
  name (GITHUB_REF_NAME). Resolve BUILD_VERSION to the tag when run on a
  tag push, else dev-<short-sha> so manual runs produce
  solo-dev-abc1234-oled.uf2 etc.

Cleanup:
- remove stray docs/solo_features/settings_screen/set_scr_1_eink copy.png

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-29 12:46:29 +02:00
Jakub
c7009140ce refactor: rename firmware from Plus to Solo
- FIRMWARE_VERSION: v1.15-plus.1 → v1.15-solo.1
- FIRMWARE_PLUS_BUILD → FIRMWARE_SOLO_BUILD in all platformio.ini and UITask.cpp
- docs/plus_features/ → docs/solo_features/ (all sub-docs moved)
- README: update all doc links plus new Documentation section
- GitHub Actions: extract GIT_TAG_VERSION in each build job (was missing,
  causing empty FIRMWARE_VERSION in builds); rename output files to
  solo-VERSION-oled.uf2 / solo-VERSION-eink.uf2; release title → "Solo VERSION"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-29 12:25:34 +02:00