Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The component reads `src/assets/shots/<name>-light.webp` and `<name>-dark.webp`.

The initial `ui-backlogs-overview` pair comes from the product's page-shot baselines at commit `0a9e4e139ce655f1f4ad457e7516fef3feef4bad`: `backlogs.spec.tsx-snapshots/backlog-{light,dark}-linux.png`. The pair is resized to 1440px and converted to WebP at quality 82. Keep each captured asset under 150 KB.

Two illustrations use product component-test fixtures at commit `3026840aedef50b41467bc2eabe827d8cddd4a55`: `src/ShipLean.Client/src/features/asks/AsksHeader.spec.tsx-snapshots/asks-waiting-{light,dark}-linux.png` and `src/ShipLean.Client/src/features/demos/DemoStatusBand.spec.tsx-snapshots/demo-band-ready-{light,dark}-linux.png`. They contain sample data, not live accounts. Their WebP pairs live in `src/assets/product-shots/` and are rendered with `ProductShot`; refresh both themes from the product baselines when those interfaces change. Three more pairs come from the product at commit `cfbdf565137a783c2a3dafed74ccb0267fcba522` (the Feature timeline): `src/ShipLean.Client/src/pages/screenshots/featureTimeline.spec.tsx-snapshots/feature-timeline-selected-{light,dark}-linux.png`, `src/ShipLean.Client/src/features/timeline/ct/GanttChart.spec.tsx-snapshots/gantt-chart-finished-{light,dark}-linux.png` and `src/ShipLean.Client/src/features/timeline/ct/TimelineRail.spec.tsx-snapshots/timeline-rail-selected-{light,dark}-linux.png`. They are converted to `feature-timeline-selected`, `gantt-chart-finished` and `timeline-rail-selected` WebP pairs at 1440px maximum width and quality 82. Two more pairs come from the product at commit `c7701e35881f6639231a5053566caf15a868999b` (Task changes): `src/ShipLean.Client/src/pages/screenshots/taskChanges.spec.tsx-snapshots/task-changes-{light,dark}-linux.png` and `task-changes-task-{light,dark}-linux.png`. They are converted to `task-changes` and `task-changes-section` WebP pairs at 1440px maximum width and quality 82. The test masks the top bar's presence area in magenta; that box is filled with the top bar colour before conversion. These product-test screenshots are separate from the seeded site-capture workflow below.
Two illustrations use product component-test fixtures at commit `3026840aedef50b41467bc2eabe827d8cddd4a55`: `src/ShipLean.Client/src/features/asks/AsksHeader.spec.tsx-snapshots/asks-waiting-{light,dark}-linux.png` and `src/ShipLean.Client/src/features/demos/DemoStatusBand.spec.tsx-snapshots/demo-band-ready-{light,dark}-linux.png`. They contain sample data, not live accounts. Their WebP pairs live in `src/assets/product-shots/` and are rendered with `ProductShot`; refresh both themes from the product baselines when those interfaces change. Three more pairs come from the product at commit `cfbdf565137a783c2a3dafed74ccb0267fcba522` (the Feature timeline): `src/ShipLean.Client/src/pages/screenshots/featureTimeline.spec.tsx-snapshots/feature-timeline-selected-{light,dark}-linux.png`, `src/ShipLean.Client/src/features/timeline/ct/GanttChart.spec.tsx-snapshots/gantt-chart-finished-{light,dark}-linux.png` and `src/ShipLean.Client/src/features/timeline/ct/TimelineRail.spec.tsx-snapshots/timeline-rail-selected-{light,dark}-linux.png`. They are converted to `feature-timeline-selected`, `gantt-chart-finished` and `timeline-rail-selected` WebP pairs at 1440px maximum width and quality 82. Two more pairs come from the product at commit `c7701e35881f6639231a5053566caf15a868999b` (Task changes): `src/ShipLean.Client/src/pages/screenshots/taskChanges.spec.tsx-snapshots/task-changes-{light,dark}-linux.png` and `task-changes-task-{light,dark}-linux.png`. They are converted to `task-changes` and `task-changes-section` WebP pairs at 1440px maximum width and quality 82. The test masks the top bar's presence area in magenta; that box is filled with the top bar colour before conversion. One more pair, `touch-drawer`, comes from the product at commit `c7701e35881f6639231a5053566caf15a868999b`: `src/ShipLean.Client/src/touch/TouchTopBar.phone.spec.tsx-snapshots/touch-drawer-{light,dark}-linux.png` (the phone navigation drawer, 304px wide), converted to WebP at quality 82. These product-test screenshots are separate from the seeded site-capture workflow below.

The hosted way to capture every screenshot is the `Capture screenshots` workflow (`.github/workflows/shots.yml`). It runs on `workflow_dispatch` and on a push to any `shots/**` branch. Hosted runners have Docker. The workflow generates a random disposable password and writes the private configuration under `$RUNNER_TEMP`. It then runs `pnpm shots --config` and uploads `src/assets/shots` as the `shots` artifact. Download it with `gh run download <run id> -n shots -D src/assets/shots`. The workflow pins `SHIPLEAN_IMAGE` to a product commit, so update that commit when the product changes. The runner lists each failed capture by name and fails the run, and the other captures still finish. A full run also fails if a `<Shot>` tag has no capture, so a deleted spec cannot leave an old image in place. Commit the artifact of a green run only, because a red run uploads a mix of new and old images. The same workflow has a `seed-test` job. It starts its own stack, runs `pnpm test:seed` against it, and removes the stack. It installs no browser and sets no Google values.

Expand Down
Binary file added src/assets/product-shots/touch-drawer-dark.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/product-shots/touch-drawer-light.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 81 additions & 0 deletions src/content/docs/ui/mobile-web.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: "ShipLean in a phone browser"
description: "How the ShipLean web app changes on phones and narrow screens: the top bar and menu, touch gestures, sheets, and the pages that stay desktop-only."
sidebar:
order: 24
---

import ProductShot from '@/components/ProductShot.astro';

The ShipLean web app adapts to narrow screens. You don't install anything: open your server's address in a phone or tablet browser and sign in as usual.

This is not the [phone app](/ui/mobile/). The phone app is a separate, installed app with Inbox, voice commands and its own screens. The web app in a browser has the web app's screens laid out for touch, except a few pages that [need a larger screen](#pages-that-need-a-larger-screen). Use the web app when you need something the phone app sends you to the web for.

## When the touch layout applies

The touch layout applies when the browser window is 900 pixels wide or less. A phone is under 600 pixels. A tablet or a narrowed desktop window is 600 to 900. The layout changes as you resize the window.

## Get around

At this width the side menu and top strip are replaced by one top bar:

- **Menu** opens the navigation drawer.
- The title shows where you are. It is the breadcrumbs unless the page sets its own title.
- Presence and the live status sit to the right of the title. A page can add one action there.
- **Quick search** opens [Quick search](/ui/navigation/).

On a page that has somewhere to go back to, such as an item opened from a list, the left side of the bar is a back arrow and **Menu** moves to the right.

<div style="max-width: 18rem">
<ProductShot name="touch-drawer" alt="The navigation drawer on a phone: the project picker, then Backlogs, Boards, Sprints, Retrospectives, Jira import and Settings with their sub-pages, and the signed-in user at the bottom." />
</div>

The drawer holds the same menu as the desktop side menu, including the project picker and your account at the bottom. Close it with **Close menu**, with **Esc**, or by tapping outside it. It also closes when you go to another page. Swiping from the screen edge does not open it.

## Dialogs, sheets and the Save bar

- Menus that are popovers on a desktop open as sheets that slide up from the bottom.
- The **⋯** button on a row or card opens a sheet of actions. Choose an action to run it, or one marked **›** to open a second sheet, such as **Sprint ›** or **Parent ›**.
- Settings and other forms open as full-screen dialogs.
- While a form has unsaved changes, a bar fixed to the bottom of the screen shows **Discard** and **Save**.
- Lists that are columns on a desktop, such as the states of a board, become pages you swipe sideways. A row of chips above the pages jumps to one.

## Backlogs

The backlog toolbar is a single row: **+ New**, the **List**, **Planning** and **Tree** switch where the level offers them, **Filter**, and **⋯ More**. Everything else is in **More**, for example **Search this list** and **Show completed**. The **Columns** and **Keys** options are not offered at this width. See [Backlogs](/ui/backlogs/).

### Move a row

Each row has a handle, a rank number with a grip under it, at its left edge. Press and hold the handle for about half a second until the row lifts, then drag it to a new place and let go. A swipe that starts anywhere else, or on the handle before the hold, scrolls the page. The handle does nothing while a filter, a search or Select mode is on.

In Planning, drop a row on a sprint header to move it into that sprint.

### Row actions

Tap **⋯** on a row for **Open**, **Points**, **Sprint ›**, **Parent ›**, **Move to top**, **Move to bottom** and **Select**. A **?** in place of the points means the item has no estimate. Tap it to open the Points sheet.

### Select mode

There is no multi-select with a modifier key on a phone. Choose **Select** from a row's **⋯** or from **More** to enter Select mode. A bar under the toolbar shows **Select all** (or **Clear all**), how many rows are selected, and **Done**. Tap rows to select them. A bar for the selection offers bulk actions such as **Parent ›**, **Tags ›**, **Move to top** and **Move to bottom**. Choose **Done** to clear the selection and leave Select mode.

## Boards and the taskboard

On a board, press and hold a card until it lifts, drag it to a column and let go, the same move as with a mouse. A card also has a **⋯** button with actions such as **Open**, **Move to**, **Lane** and **Move to top**. Tapping a card opens its item.

On the sprint Taskboard, a long press lifts a task card. While you hold a card at the left or right edge of the screen, the board turns to the next page. If you press and release without moving, the card's actions open: **Move to another story ›**, **Assignee** and **Open** with the task's key.

## Item pages and images

Item pages use the same touch layout. Tap an image attached to an item to open it in a full-screen viewer. Pinch or double-tap to zoom, drag to pan while zoomed, and swipe to move between images when not zoomed. **Close** closes the viewer. Its **⋯** menu offers **Download**, **Copy link** and **Open original**.

## Pages that need a larger screen

These pages are built for a desktop screen and are not adapted for touch:

- New project, Import start and Jira import
- Authorize
- Instance settings
- The [Feature timeline](/ui/feature-timeline/). Its **Open timeline** link is hidden on the Feature page.
- Task changes. A narrow screen shows **Changes need a wider screen.**, with a link back to the item. The task itself still opens without its changes.

Open these on a computer.
26 changes: 25 additions & 1 deletion src/content/docs/ui/mobile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:

The ShipLean phone app is for quick project updates, answers and voice commands. It is available for iOS and Android. The documented release path distributes iOS builds through TestFlight and Android builds through Google Play internal testing. Ask your ShipLean administrator or team for the current tester invitation; production store availability depends on the separate store review and release process.

The app is a companion to the web app. It currently focuses on **Inbox**, **Backlog**, **Features** and **Retro**. Use the web app for screens or actions the phone app directs you to open there.
The app is a companion to the web app. It currently focuses on **Inbox**, **Backlog**, **Features** and **Retro**. Use the web app for screens or actions the phone app directs you to open there. The web app also works in a phone browser; see [ShipLean in a phone browser](/ui/mobile-web/).

## Install and sign in

Expand All @@ -30,6 +30,30 @@ The voice models take substantial storage and download time. Setup selects **Aut

In **Account → Voice**, you can review voice status and change or download models. **Model licences** lists the licences for the bundled speech and command models. If voice is unavailable, check that setup is complete, a model is ready and microphone permission is granted. You can still use the rest of the app without voice.

### Mic tuning

If voice does not hear you, tune the microphone. The app counts silent holds in a row. After the second one, the "Didn't hear anything" message has a **Tune mic** action. After the third, the app opens **Mic tuning** for you, and **Back** returns you to the screen you were on. The count starts again after two minutes without a silent hold. You can also open it any time from **Account → Voice → Mic tuning**, which shows the input in use and when you last tested.

Voice records from the phone's own microphone and plays through its loudspeaker. The top card of **Mic tuning** names the input in use. Choose **Change** to pick another from **Listen through**. If the input you picked is disconnected, the app falls back to the phone. Each input keeps its own sensitivity, so test again after you change it.

To run the test, choose **Start the test**. It takes about 10 seconds:

1. **Stay quiet.** The app measures the room for 3 seconds.
2. **Hold the mic and say** the phrase on screen, for example "Move SHIP-123 to Done", at your usual distance. Release when you have finished.

The result is one of these:

- **Your mic is working.** The app sets the sensitivity from your voice and the room, and shows what it heard.
- **Your voice was coming through quietly.** It was too quiet for the old setting, so voice heard nothing. The app makes voice more sensitive.
- **The room is too noisy.** Move closer to the mic and away from the noise, then test again.
- **No sound is reaching ShipLean.** The app lists things to check, such as microphone access being off, another app using the microphone, or something covering the mic.

If the phone recorded from a different input than the one you picked, the result says **Wrong input** and names both.

Under **Adjust by hand**, **Automatic** is on by default and uses the sensitivity the test set. Turn it off to move the sensitivity yourself on a scale of 1 to 10, from **Less sensitive** to **More sensitive**, while the meter shows your voice. Choose **Save** to keep it. The setting on **Voice** then shows **Manual** instead of **Automatic**.

Mic tuning is touch only. It does not take voice commands.

### Use the microphone

Hold the microphone control while speaking, then release it. The app turns the request into a preview of the actions it understood. Review the preview before applying it; you can remove a line or cancel the preview. This confirmation is important for commands that change more than one item. Voice commands are limited to the actions available on the current screen. If an action is web-only, the app tells you where to do it.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ui/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Project screens use `/p/:key/...`, where the key is the project key. The profile

<Shot name="ui-navigation-project-picker" alt="The project picker with search and project choices." />

Press **Ctrl+P** on Windows or Linux, or **⌘P** on macOS. You can also select the search button beside the ShipLean mark. Either action opens Quick search. On narrow screens under 900px, use the search icon in the top strip after the project button. Pressing the shortcut while Quick search is open selects the input text. It does nothing while another modal dialog is open. Quick search closes the project picker when opened.
Press **Ctrl+P** on Windows or Linux, or **⌘P** on macOS. You can also select the search button beside the ShipLean mark. Either action opens Quick search. On screens 900px wide or less, use the search icon at the right of the top bar. Pressing the shortcut while Quick search is open selects the input text. It does nothing while another modal dialog is open. Quick search closes the project picker when opened.

<Shot name="ui-navigation-quicksearch" alt="Quick search open with its search field, recent work items, and available actions." />

Expand All @@ -49,7 +49,7 @@ Select your account at the bottom of the menu to open **Your profile** and sign

Use your profile's Appearance section to choose a theme and density. Your appearance setting is saved to your account. On project screens, the top bar can show who else is on the same screen. This indicator does not appear on install-level pages such as your profile.

The top bar also shows breadcrumbs for the current location. On narrower screens, the side menu becomes a strip across the top.
The top bar also shows breadcrumbs for the current location. On screens 900px wide or less, the side menu becomes a drawer that opens from the top bar's **Menu** button. See [ShipLean in a phone browser](/ui/mobile-web/).

## Keyboard shortcuts

Expand Down
4 changes: 4 additions & 0 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ export const sidebar = [
"label": "ShipLean on your phone",
"link": "/ui/mobile/"
},
{
"label": "ShipLean in a phone browser",
"link": "/ui/mobile-web/"
},
{
"label": "Sign in and your profile",
"link": "/ui/profile/"
Expand Down
Loading