Skip to content

Docs: screenshots still missing for the barcode scanner, error screens, and three others #100

Description

@joemasilotti

Several visual APIs are documented in prose with no picture of what they look like. The 0.12.0 pass closed the highest-priority gaps (navbar segments and share buttons on Android, badges on Android, the iOS review prompt, and the iOS in-app purchase sheet). What is left, roughly in order of value:

  1. Barcode scanner, both platforms. The page has no imagery at all, and this is the most visual and most differentiating feature in the set. Needs a real device pointed at a code, since a simulator cannot scan.
  2. Error and offline screens, both platforms. Cheap to capture and they show a customer both what an end user sees and what the copy configuration actually styles.
  3. Review prompt, Android. The iOS half shipped. Android's in-app review dialog only appears for an app installed by Play, so this one needs the demo app installed from the store on a device rather than a local build.
  4. Forms flow, Android. forms/ ships an iOS gif only. The recording mode in demos/docs is the tool.
  5. Overscroll, either platform. Motion-only and the smallest win here.

How the wiring works, so nobody redoes this

There is no wiring step. DocsRenderer.build_device_row_html pairs any source="X/ios" with a sibling android.png on disk and renders the platform toggle itself. Dropping a correctly named file into public/docs/screenshots/ is the entire job. A first attempt at adding explicit "on Android" rows doubled every image and had to be reverted.

One consequence worth respecting: a row's callout box and dimensions are shared by both platforms' images, so an Android capture should match its iOS counterpart's dimensions or the callout lands in the wrong place on one of them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions