Skip to content

Docs: trim the design system reference and drop vendor names from prose - #91

Merged
SandObserver merged 1 commit into
mainfrom
docs/trim-design-system
Aug 16, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/trim-design-system

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Cut rationale, history and narrative from docs/design-system.md; every measured value and table is kept. 2196 words to 1536.
  • Update the touch-slider paragraph to the per-axis radius the control uses since Fix: iOS screen fill, app icons, and touch slider ends #90.
  • Reword comments, docs and test descriptions so platform behaviour is described in neutral terms rather than by vendor name.
  • Rename two device strings in a nowplaying test fixture; no code matches them.
  • Add a short "Platform identifiers" note to docs/frontend.md recording which vendor names are identifiers rather than references.
  • Restamp the cache-busting versions the edited modules cascade through.

Identifiers are deliberately unchanged, because renaming them breaks the app: the -apple-system / BlinkMacSystemFont font-family keywords, the apple-touch-icon and apple-mobile-web-app-* meta names read at add-to-homescreen time, the stored showLabels.ios config key, user-agent patterns, the Playwright device name and __MACOSX/ in .gitignore. CHANGELOG.md is untouched as a historical record.

Testing
All green: 1184 backend tests, 801 frontend, lint, format, both typechecks, cache-busting check and the Docker smoke build on the homelab. No behaviour changes and no tests added; the edits are comments, docs, and two fixture strings.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

Cut the rationale, history and narrative from docs/design-system.md,
keeping every measured value and table. Update the touch-slider entry to
the per-axis radius the control now uses.

Describe platform behaviour in neutral terms across comments, docs and
test descriptions. Identifiers stay as they are: font-family keywords,
meta names read at add-to-homescreen time, the stored showLabels.ios key
and user-agent patterns cannot be renamed. Record that in
docs/frontend.md so the remaining occurrences are not mistaken for
references.

Restamp the cache-busting versions the edited modules cascade through.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 16, 2026
@SandObserver
SandObserver merged commit 08b56aa into main Aug 16, 2026
4 checks passed
@SandObserver
SandObserver deleted the docs/trim-design-system branch August 16, 2026 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant