Skip to content

Add Units, Measurement & Locale user guide page#1766

Merged
garthvh merged 5 commits into
mainfrom
docs/units-measurement-locale
May 9, 2026
Merged

Add Units, Measurement & Locale user guide page#1766
garthvh merged 5 commits into
mainfrom
docs/units-measurement-locale

Conversation

@garthvh

@garthvh garthvh commented May 9, 2026

Copy link
Copy Markdown
Member

What Changed

New user-facing documentation page explaining how the app automatically adapts units, measurements, and date/time formatting to the user's device locale settings.

Why

Following the measurement/locale audit (#1764) and the new design standards (meshtastic/design#76), users need a clear reference explaining that unit conversion is automatic and where to change their system settings.

New Files

  • docs/user/units-and-locale.md — Full user guide covering temperature, distance, altitude, speed, wind, weight, rainfall, barometric pressure, and date/time formatting
  • docs/assets/screenshots/settingsLanguageRegion.png — iOS 26 Settings → Language & Region screenshot
  • docs/assets/screenshots/MANUAL_SCREENSHOTS — Manifest for non-test-generated screenshots
  • scripts/cleanup-screenshots.sh — Removes orphaned PNGs not referenced in docs or listed in MANUAL_SCREENSHOTS

Changes to Existing Files

  • docs/index.md — Added Units & Locale quick link
  • docs/user.md — Added What's New entry
  • scripts/copy-snapshots.sh — Integrated automatic cleanup after copy
  • Regenerated bundled HTML docs

How It Was Tested

  • cleanup-screenshots.sh --dry-run confirms 0 orphans across 88 screenshots
  • build-docs.sh generates the new HTML page successfully
  • Screenshot captured from iOS 26 Simulator

Screenshots

The new page includes an iOS 26 Settings → Language & Region screenshot showing Temperature, Measurement System, Calendar, First Day of Week, Date Format, and Number Format settings.

garthvh added 5 commits May 9, 2026 11:16
- New docs/user/units-and-locale.md covering how the app automatically
  adapts temperatures, distances, speeds, weight, rainfall, and
  date/time formatting to the user's device locale settings
- Documents where to change measurement system and date/time settings
  on iOS and macOS
- Explains universal units that never convert (hPa, degrees, µR/hr)
- Added What's New entry and Quick Links reference
- Regenerated bundled HTML docs
- Captured iOS Settings → General → Language & Region screenshot
  showing Temperature, Measurement System, Calendar, Date Format,
  and Number Format settings
- Added settings summary table linking each setting to its effect
  in the Meshtastic app
- Removed redundant 'where to change it' tables now covered by
  the screenshot
- Rebuilt bundled HTML docs and copied screenshots
- Replaced iOS 18 screenshot with iOS 26 Language & Region screen
- Added First Day of Week to settings summary table
- Shows Region Format Example preview at bottom of screen
Lists screenshots captured manually (e.g., iOS Simulator Settings
screens) so future cleanup scripts know not to delete them.
- New scripts/cleanup-screenshots.sh removes orphaned PNGs from
  docs/assets/screenshots/ that are not referenced in any markdown
  file and not listed in MANUAL_SCREENSHOTS
- Supports --dry-run to preview deletions without removing files
- Integrated into copy-snapshots.sh so cleanup runs automatically
  whenever screenshots are copied to the app bundle
@garthvh
garthvh merged commit 6a80036 into main May 9, 2026
3 checks passed
@garthvh
garthvh deleted the docs/units-measurement-locale branch May 9, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant