Skip to content

Add the tray along the bottom of the window, and move the terminal into it - #612

Merged
zaerl merged 5 commits into
redesign/wpdsfrom
add/bottom-tray-terminal
Oct 4, 2026
Merged

zaerl merged 5 commits into
redesign/wpdsfrom
add/bottom-tray-terminal

Conversation

@zaerl

@zaerl zaerl commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Why

First part of #558. In the redesign the terminal, the logs and the mail leave the foot of each site's page for a tray along the bottom of the window, as the prototype has them. This pull request builds the tray and moves the terminal into it; the logs and the mail follow in their own pull requests and stay on the page until then.

What changes

The tray. Between the page and the footer, closed when the window opens. The footer has a button for it, "Toggle Terminal", pressed while the tray is open; the tray's own Close button puts the focus back on that button. Its top edge is dragged with a pointer or moved with the arrow keys (Home is its smallest, End its largest), from 200px up to half the window. It takes its room from the page, so nothing on the page is under it, and a confirmation in the corner stands clear of it.

The terminal. The tray is the window's and what is in it is a site's: every site's view fills the tray's slot with its own terminal, hidden unless the site is the open one. A terminal keeps what was printed in it through a close and a look at another site. It is fitted to the tray, as many columns and rows as there is room for, where it was a fixed 80 by 12.

When the tray opens by itself. On the page the terminal was always in view, and the app leaned on that. So the tray opens on the terminal in the cases whose only word is there:

  • an install or a build that fails with its output in the terminal (setup, an update, an applied patch);
  • an action refused because a command is running, which is a line printed there;
  • an update that cannot fetch, and an apply whose hand-off to the build watch fails.

It does not open for a run the contributor stopped, for a failure whose output is in the logs (the build that runs ahead of the watch), or on another site than the one that failed; that site's terminal comes up when the site is opened. The copy that said "the Terminal below" now says "the Terminal".

Not in this pull request:

  • The logs and the mail in the tray.
  • Remembering the tray's height or whether it was open across restarts. The prototype remembers the height; the window's other arrangements (the sites list, the details) are not remembered either.
  • A slide animation as the tray opens.
  • The user guide, which still describes a terminal panel on the page: Retake all screenshots and update guide text #561 retakes the screenshots and the text.

How to test this

Platforms: any. The journeys below drive every part of this on macOS and Windows. From the repository root, after npm ci and npm run build:once:

npx playwright test --project=journeys tray.spec terminal.spec

tests/e2e/journeys/tray.spec.js is new, nine journeys:

  • closed until the footer opens it; shows the open site's own terminal; each terminal survives a close and a look at another site; the page and a confirmation are not under it;
  • the edge moves by keyboard and by pointer, stays inside its limits, a drag that loses the pointer is over, and the terminal is fitted (rows and columns) at every size;
  • a failed build, an update that cannot fetch and a refusal each bring the terminal up; a stopped build, a failure whose output is in the logs, a failure on another site and a site deleted mid-build do not.

I removed or broke 26 behaviours one at a time; 25 turned a journey red, and the one that did not was a redundant clamp, which is gone. tests/unit/tray.test.cjs and tests/unit/terminal-hints.test.cjs hold the decisions (limits, keys, the terminal's grid, which run's end shows the terminal).

Worth a look by hand (any platform, the current head): open a site, press the icon at the left of the footer, drag the tray's top edge, type help, switch site and back, close it. Then choose Update to latest trunk on a site with no remote, or let a build fail: the tray opens on the reason.

What must not have happened: a site's terminal losing its output when the tray is closed or another site is opened; the tray opening for something the contributor did on purpose (a stop); anything on the page ending up under the tray.

What cannot be tested by hand here: "Stop setup" during a real first setup, which needs a clone and an install that take minutes. The stop is decided in one place for every run, and a journey covers it through Ctrl+C.

Risks and limitations

  • Review: 2 passes, 13 findings fixed here, 4 left as follow-ups, 1 design question. Details below.
  • The footer's button is an icon with a tooltip, as in the prototype, and the copy now says "the Terminal" without saying where it is. A failure opens the tray, so nobody is left looking for the output of one. The sentences that are not failures ("Run npm run build in the Terminal", "the Terminal shows what it is doing") point at a tray the contributor has to find. The second reviewer suggested a visible "Terminal" label beside the icon; I have left that as a design decision.
  • A build's output is no longer always in view. During a long setup or update the page shows the steps and the terminal stays closed unless it is opened.
  • Erasing typed input breaks once the line wraps. It did before; a terminal that follows the window's width makes it easier to reach in a narrow window.
  • The hint sentences under the terminal are still not translatable, as before.

Related

Part of #558. Mail HTML rendering is unchanged and tracked separately.


Design decisions and alternatives considered
  • In the page's flow, not laid over it. The prototype lays the tray over the foot of the page and pads the page by its height. Here it is a row of the window's column, so the page is simply shorter: nothing to pad, and the page's own scrolling and its sticky details need no knowledge of the tray.
  • Never unmounted. A terminal is drawn in one element for as long as it lives, and the prototype's tray, which mounts only what is selected, would cost every other site its terminal. The tray and every site's panel stay in the document, hidden.
  • The terminal is made when the site's view mounts and drawn when first shown. What a site prints before then is kept in the terminal's buffer. Its element arrives through the tray's slot a render later, so it is state and not a ref.
  • One reveal function per site, which waits if the site is not the open one, rather than opening the tray on whatever site is in front.
  • A run's caller says where its output goes (outputInTerminal), and the runner knows whether it was asked to stop. Opening the tray only where the page points at the terminal was considered and is the same thing with more places to keep in step.
  • A splitter, not a button, for the edge: it can be focused, moved with the arrow keys, and says how tall the tray is.
Review outcome (required — see AGENTS.md)

Pass 1: 8 [fix here] · 3 [follow-up]. Pass 2 (on the fix-up): 3 [fix here] · 3 [follow-up]. 13 fixed (7 and 6), 4 left as follow-ups (the guide, deferred to #561, and pass 1's three), and 1 design question.

  • Review: completed — a separate agent context, read-only; head 480ee0e / base bda9083; lint and the tray's unit tests run, the journeys read and not run; 8 [fix here], 3 [follow-up].
    • Fixed: the app said "the Terminal below" with the tray closed, and refusals were printed only there (the tray now opens for a failure or a refusal; decided with the maintainer); the tray's floor left the terminal no rows; no test checked the terminal's columns; one layout check read positions once; Home and End were the reverse of a splitter's, and the edge did not name its pane; a drag could get stuck; confirmations covered the open tray.
    • Deferred to Retake all screenshots and update guide text #561: the user guide.
    • Follow-ups: wrapped input, the untranslated hints, a terminal that cannot move to a new element (no path does).
  • Review: completed — a second separate agent context, read-only; head 4e0cdff / base bda9083; every caller of the two runners and of the kill traced; 3 [fix here], 3 [follow-up].
    • Fixed: "Stop setup" opened the tray on a stop that was asked for; an update that fails before it runs anything said so only in the terminal; a site deleted mid-build opened the tray on the next site.
    • Fixed though marked follow-up: the journey measured a column off an element xterm keeps for itself; an assertion at the smallest height that could not fail; the decision moved into terminal-hints.cjs with a unit test, and the watcher says its output is not in the terminal.
    • Left as a design decision: a visible label on the footer's button.
  • Since review: 4e0cdff → d89b1a8 is those fixes, and edd378a merges redesign/wpds (Hold the site menu's "Update to latest trunk" while an update, install or build runs, and say why #611), with one conflicting line in the site view resolved to keep both changes; lint, npm test, npm run test:electron, all 108 journeys, the small-window and slowed runs of the tray's journeys and the packaged smoke re-run on it. Then f595b31, after both journey jobs failed on edd378a in the new edge journey, for reasons of the journey's own: on Windows it measured the terminal before the site's status had brought the two hints under it, and on macOS its own measure of a column came out a hair wider than the terminal's on the runner's font. The journey now waits for the hints and counts columns from the room left over; no app code changed.
Implementation notes
  • New: src/renderer/tray.cjs, src/renderer/components/bottom-tray.jsx, tests/unit/tray.test.cjs, tests/e2e/journeys/tray.spec.js. runFailedInTerminal is in src/renderer/terminal-hints.cjs.
  • The tray's height reaches the stylesheet as a property the component sets from an effect (--app-tray-height on the tray, --app-tray-inset on the document for the confirmations), since the lint rules forbid an inline style.
  • A dozen journeys now open the Terminal tray first; ui.openTray, ui.tray and ui.trayToggle are in tests/e2e/helpers/ui.cjs.
  • Local checks on macOS: npm run lint clean, npm test and npm run test:electron pass (1930 tests), npm run test:e2e 108 pass, npm run test:e2e:packaged 15 pass.
Screenshots or recording

Not attached: I have no way to upload images from the command line. The steps under "Worth a look by hand" show everything that changed.

🤖 Generated with Claude Code

zaerl and others added 3 commits October 4, 2026 19:00
…to it

First part of #558. The window has a tray between the page and the footer,
closed until the footer's button opens it, as tall as its top edge is
dragged or moved with the arrow keys, and never more than half the window.
It takes its room from the page, so nothing on the page is under it.

The terminal is no longer a panel at the foot of a site's page. The tray is
the window's and what is in it is a site's: every site's view fills the
tray's slot with its own terminal, hidden unless the site is the open one,
so a terminal keeps what was printed in it through a close and a look at
another site. It is fitted to the tray, as many columns and rows as there is
room for, where it used to be eighty by twelve.

The logs and the mail stay on the page until their own pull requests.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… and fix what the review found in the tray

Review fix-ups for the first part of #558.

The page still pointed at "the Terminal below" with the tray closed. The
copy drops "below", and the tray opens on the terminal by itself in the two
cases whose only word is there: an install or a build that failed with its
output in the terminal, and an action refused because a command is running.
A site that is not the open one waits until it is. The build that runs
ahead of the watch prints in the watch's log and does not open it.

Also: the tray's floor is high enough for the terminal to keep its rows;
Home and End are the smallest and the largest, as a splitter's are, and the
edge names the tray; a drag that loses the pointer is over; confirmations
stand clear of the open tray; and the journeys check the terminal's columns
and poll what the page's layout decides.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…n update that cannot fetch

Second review pass on the tray.

"Stop setup" on the page ended a run with a code that is not zero, and the
tray opened on a stop that was asked for. The runner records a stop again,
and what counts as a failure that shows the terminal is decided in
terminal-hints.cjs, with a unit test.

An update that fails before it runs anything, with no origin to fetch from
or a fetch that fails, says why only in the terminal: the terminal is
brought up for it, as it is for an apply whose hand-off to the watch fails.
A site deleted while it builds no longer opens the tray on the site that is
left. The tray's floor leaves the terminal three rows, and the journey
measures a column off the text on screen.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: WordPress/contributor-toolkit/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a3cda2a9-87e6-4d4a-a1fb-3bf45f40db41

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

zaerl and others added 2 commits October 4, 2026 21:35
Brings in the held "Update to latest trunk" menu item (#611). The update
hook's call in the site view takes both changes: `updateHeld` from there,
and the two functions that bring the terminal up from here.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…olumns with room for the font

Both platforms failed one journey on the pull request, each for a reason of
the journey's own.

On Windows the terminal was measured before the site's status had arrived.
The two hints under the terminal came after, took their two lines from its
room, and the terminal had fewer rows after the tray was made taller than
the journey had counted before. The journey waits for the hints.

On macOS the journey's measure of a column, taken off the text on screen,
came out a hair wider than the terminal's own on the runner's font, and a
terminal whose rows fitted was counted as one column over. Columns are now
counted from the room left beside the rows, with a twentieth of a column to
spare.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@zaerl zaerl self-assigned this Oct 4, 2026
@zaerl
zaerl merged commit 2ef8177 into redesign/wpds Oct 4, 2026
8 checks passed
@zaerl
zaerl deleted the add/bottom-tray-terminal branch October 4, 2026 20:04
zaerl added a commit that referenced this pull request Oct 4, 2026
…a server that fails (#613)

## Why

Second part of #558.
#612 built the tray
along the bottom of the window and moved the terminal into it. This pull
request moves the logs there, as the prototype has them; the mail
follows in its own pull request and stays on the page until then.

## What changes

**A second button in the footer, "Toggle Logs".** The tray holds one
thing at a time, the terminal or the logs, and each button puts its own
in the other's place or closes the tray.

**The three logs are tabs in the tray**, drawn with the design system's
tabs: Server, Build watch, Debug.log. The selected log fills the tray
and follows its height; debug.log's path and its three buttons (Show in
folder, Copy, Clear) are along the bottom of its tab. The Logs section
is gone from the page. Each site keeps its own logs and its own selected
tab, as each keeps its own terminal.

**The tabs follow the app's choice of tab (a fix).** The old tab panel
kept its own idea of which tab was open, so the app's "show the watch's
tab" never changed what was on screen. The tabs are controlled now:
starting the build watch on a site with no build shows the watch's tab,
as the code always meant.

**When the tray opens by itself.** On the page the logs were always in
view, and two failures have their only words there. So the tray opens on
the Logs:

- on the Build watch tab, when the build watch ends by itself or the
build that runs ahead of it fails;
- on the Server tab, when the development server stops by itself or
cannot start.

The logs never take the terminal's place: someone may be typing there.
With the terminal open the tab is still selected, and the page says what
happened and where its last lines are, which for the server is new: "The
development server stopped by itself. Its last lines are in the Logs."
and "The development server could not start. Its last lines are in the
Logs.", under the server's details until it is started again. The
terminal may still take the logs' place for a failure or a refusal
printed there. A watch or a server stopped by its own button brings
nothing up, and a failure on another site than the open one waits until
that site is opened.

**Labels follow the prototype:** "Build watcher" is "Build watch" and
"debug.log" is "Debug.log" on the tabs. Two sentences that quoted the
header's label ("Wait for the header to say Build watching") no longer
quote anything: the label is hidden in a narrow window.

**Not in this pull request:**

- A count of unseen debug.log lines on the footer's button while the
tray is closed. The count is on the Debug.log tab, as before, so a
closed tray hides it. It comes as the next pull request.
- The mail in the tray.
- The user guide, which still shows the logs on the page: #561 retakes
the screenshots and the text.

## How to test this

Platforms: any. The journeys below drive this on macOS and Windows. From
the repository root, after `npm ci` and `npm run build:once`:

```
npx playwright test --project=journeys tray.spec logs.spec build-watch.spec dev-server.spec
```

- `tray.spec.js`: the tray holds one thing at a time; a watch that fails
brings the logs up, one stopped by its button brings nothing, and
neither takes the terminal's place; a refusal by the watch is said in
the terminal; a site whose deletion fails brings nothing up later.
- `logs.spec.js`: the Logs tray shows debug.log's lines, the pane grows
with the tray, lines that arrive while the tray is away are there when
it comes back, and the pane is at its end after a reopen.
- `build-watch.spec.js` and `dev-server.spec.js`: the watch's tab is
selected when the watch ends; a server that crashes with the tray closed
opens the Logs on the Server tab and the page says so; a start that
fails under the terminal leaves the terminal, and the page says so; the
sentence goes when the server is started again.

I broke 20 behaviours one at a time; 19 turned a journey red, and the
one that did not was a guard nothing needed, which is gone.
`tests/unit/tray.test.cjs` and `tests/unit/site-processes.test.cjs` hold
the decisions (which request takes the tray, what the server's details
say).

**Worth a look by hand** (any platform, the current head; the journeys
stand in for the server and the watch, so this is the part they cannot
reach): on a site that is set up, press **Start development server**,
open the Logs from the footer, and look at the three tabs while the site
is used: the server's lines under Server, the watch's under Build watch,
and under Debug.log whatever `wp-content/debug.log` gets, with **Show in
folder**, **Copy** and **Clear** along the bottom. Drag the tray's top
edge: the log follows it. Open another site and come back: the tab that
was selected still is.

**What must not have happened:** a log losing lines while the tray was
closed, was showing the terminal, or another site was open; the logs
taking the place of a terminal someone is typing in; the tray opening
for a watch or a server the contributor stopped.

**What cannot be tested by hand here:** a real server that fails to
start or dies, which I could not stage. Main tells the window of a
failed start twice, with an answer and with the server's exit, so which
of the two new sentences a real failed start gets depends on which
arrives first; both say where the lines are. The journeys cover each
message on its own.

## Risks and limitations

- Review: 2 passes, 12 findings fixed here, 1 answered only in part (the
next but one point), 4 left as follow-ups. Details below.
- **The logs are no longer always in view.** A new line in debug.log
shows nowhere while the tray is closed, until the next pull request puts
its count on the footer's button.
- **With the terminal open, a failed watch or server does not open the
logs.** That is the rule chosen for this tray; the page's sentence is
what says it.
- A kill that outlasts a failed deletion's five-second wait can still
bring the logs up afterwards, for an ending the deletion caused. The
path where the kill lands in time is covered.
- After a failed deletion the page says the build watch "ended by
itself", and when a start is refused because a command holds the
terminal the Server tab says the build watch "stopped before build/ was
complete". Both sentences were there before and are untrue in those two
cases.
- The logs' strings are still not translatable, as before.
- The packaged smoke failed once, at "the packaged app boots and paints
its first window", on the run straight after packaging, and passed 15 of
15 on the next run with nothing changed. I could not reproduce it.

## Related

Part of #558. Follows
#612. Mail HTML
rendering is unchanged and tracked separately.

---

<details>
<summary>Design decisions and alternatives considered</summary>

- **The logs never replace the terminal; the terminal may replace the
logs.** Three rules were put to the maintainer: this one, whatever fails
takes the tray, and nothing ever swaps an open tray. Under the second a
watch that dies takes the tray from someone typing a command; under the
third a refusal printed in the terminal while the logs are open looks
like a button that did nothing. The rule is one function,
`trayAfterReveal` in `src/renderer/tray.cjs`, and a request made while
the site is not the open one is kept by the same rule.
- **The page says a server failed.** With the logs kept out of the
terminal's way, a failed start under an open terminal had no words on
screen at all. The server's entry gets a failed state with a sentence,
as the watch's already had.
- **Controlled tabs.** The app chooses the tab when something happens (a
watch starting, a server failing), so the selection is the site's state
and not the tab component's.
- **All three logs stay in the document's memory, one is drawn.** The
design system's tabs unmount the panels that are not selected; the lines
are the site's state, so nothing is lost, and each pane goes to its end
when it is drawn again.
- **Debug.log's buttons stay with its tab**, along the bottom, and not
in the tray's title bar: they act on one log, and the prototype's tray
has no place for them at all.

</details>

<details>
<summary>Review outcome (required — see AGENTS.md)</summary>

**Pass 1: 6 [fix here] · 3 [follow-up]. Pass 2 (on the fix-up): 6 [fix
here] · 2 [follow-up], counted from its list; its own headline said 5
and 3. 12 fixed (7 and 5), 1 answered only in part, 4 left as
follow-ups.**

- **Review:** completed — a separate agent context, read-only; head
`3afcd88` / base `2ef8177`; lint and the unit tests run, the journeys
read and not run; 6 [fix here], 3 [follow-up].
- Fixed: the screenshot script looked for a tab by its old name; the
server's failures were said only in a tab of a closed tray (the tray now
opens for them); the logs took the terminal's place while someone might
be typing there (they no longer do; the rule was the maintainer's choice
of three); a site whose deletion fails kept a pending request that fired
later; two sentences quoted a header label that a narrow window hides;
the real-setup journey could no longer tell an idle watch from one that
had exited; and, marked follow-up, a "nothing opened" check that could
pass by timing.
- Follow-ups: the count of unseen debug.log lines while the tray is
closed (the next pull request); the untranslated strings.
- **Review:** completed — a second separate agent context, read-only;
head `1c0d06f` / base `2ef8177`; lint and the tray's and the watch's
unit tests run, every request to show the tray traced to what ends up on
screen; 6 [fix here], 2 [follow-up].
- Fixed: a server failure under an open terminal was silent (the page
says it now); a request kept for a site that is not open was
last-write-wins, against the tray's own rule; two journey assertions
that could not fail; "Wait for it to finish" said of a watch that never
finishes.
- Answered in part: a kill that outlasts a failed deletion's wait still
brings the logs up, against what a comment claimed. The comment now says
what is and is not covered and the gap is in Risks; closing it means
main telling the window which endings a deletion caused, which is more
than this change should carry.
- Follow-ups: the Server tab's cancelled line when the cause is a
refusal; the watch's status after a failed deletion. Both predate this
change.
- **Since review:** `1c0d06f → 637d29a` is those fixes, not reviewed
again. The fix for the silent failure is the one the reviewer proposed,
and a journey pins that the sentence goes when the server is started
again (red without the line that clears it). The run with a slowed
status read then showed one journey of the header's racing the site's
status, one time in five: it read where the page was while the app was
still bringing the site's next step into view. It now waits for the
status and has the app jump instead of glide; ten slowed runs pass.
Lint, `npm test`, `npm run test:electron`, all 111 journeys, the
small-window and slowed runs of the affected journeys and the packaged
smoke re-run on `637d29a`.

</details>

<details>
<summary>Implementation notes</summary>

- New: `src/renderer/components/logs-panel.jsx`. `trayAfterReveal` is in
`src/renderer/tray.cjs`; the server's failed state is `serverProcess`'s
in `src/renderer/site-processes.cjs`, fed by `serverFailure` in
`use-dev-server.jsx`, which is cleared when a start is asked for.
- `useSiteLogs` takes `shown` and hands out callback refs for the three
panes, since a pane is in the document only while its tab is selected
and the tray's slot fills a render after the site's view mounts.
- The build that runs ahead of the watch and the watch itself say their
output is not in the terminal (`outputInTerminal: false`), so their
failure opens the logs and not the terminal.
- Journeys that read the watch's state off a tab's label now read it off
the header's process menu, which is on screen whatever the tray shows.
- Local checks on macOS: `npm run lint` clean, `npm test` and `npm run
test:electron` pass (1937 tests), `npm run test:e2e` 111 pass, `npm run
test:e2e:packaged` 15 pass.

</details>

<details>
<summary>Screenshots or recording</summary>

Not attached: I have no way to upload images from the command line. The
steps under "Worth a look by hand" show everything that changed.

</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
zaerl added a commit that referenced this pull request Oct 5, 2026
## Why

Third and last part of #558. The terminal
(#612) and the logs
(#613) are in the
tray along the bottom of the window; the mail a site's WordPress sent
was still a section at the foot of each site's page. This moves it into
the tray, as the prototype has it.

## What changes

**A third button in the footer, "Toggle Email".** The tray holds one
thing at a time: the terminal, the logs or the mail.

**The mail in the tray.** The open site's list, newest first, filling
the tray, and under it where the mail server is listening. A row opens
its mail in the dialog, as before. The Mail section is gone from the
page. Each site keeps its own list, as each keeps its own terminal and
logs.

**"Clear emails" is in the tray's heading**, beside the button that
closes it, and cannot be pressed while the list is empty. That is the
prototype's, and it takes one thing away: the list is empty until the
dev server has first run, whatever the app holds from before, so mail
kept from an earlier session can be cleared only once the server has
been started. Before, the button could always be pressed.

**The logs take nothing's place when the app brings them up.** They gave
way to the terminal alone, where someone may be typing; with the mail
open someone may be about to open one. They come up by themselves only
in a tray that is closed or already showing them, and the page says
where a failure's lines are, as it does under the terminal. The terminal
still takes the tray whatever is in it.

**The count on the Logs button** starts at the footer's top edge and is
one line tall, so that a wide one is clear of the envelope beside it,
and is drawn over the buttons.

**Labels follow the prototype:** the tray is "Email", and an empty list
says "No mail yet. WordPress transactional email will appear here once
the site sends any."

**Not in this pull request:**

- A sign that mail has arrived while the tray is closed or showing
something else. On the page the list was always in view; now such a mail
shows nowhere until the tray is opened. Left out on purpose, by the
maintainer's decision.
- The dialog a mail opens in. Mail HTML rendering is unchanged and
tracked separately.
- The user guide and the README, which still describe a Mail panel on
the page: #561.

## How to test this

Platforms: any. The journeys drive this on macOS and Windows. From the
repository root, after `npm ci` and `npm run build:once`:

```
npx playwright test --project=journeys mail.spec tray.spec site-header.spec
```

- `mail.spec.js`: the mail is in the Email tray, named and headed for
it, and with the tray put away no row is on screen; a row opens the mail
that was clicked; mail that arrives joins the list for its own site
only; "Clear emails" is disabled with nothing to clear, empties the list
and what the app keeps, and is disabled again.
- `tray.spec.js`: each of the three footer buttons puts its own in the
tray in the others' place; with two sites the heading has one "Clear
emails"; a build that fails with its output in the logs leaves an open
Email tray where it is, and the page says where the lines are.
- `site-header.spec.js`: two journeys used the Mail section as the end
of the page and now give the page its height with the tray.

I broke seven behaviours of the mail tray one at a time and each turned
a journey red, and the details' two rules (always let go, never let go)
at three window sizes. `tests/unit/site-mail.test.cjs` and
`tests/unit/tray.test.cjs` hold the decisions.

**Worth a look by hand** (any platform, the current head; I have not
done this, the journeys stand in for the server): on a site that is set
up, press **Start development server**, then press the envelope in the
footer. The tray says where SMTP is listening. Make WordPress send a
mail, for example **Lost your password?** on the site's login page: the
mail is in the list. Press its row: the dialog opens. Close it and press
**Clear emails**: the list is empty and the button cannot be pressed.

**What must not have happened:** a site's mail in another site's tray;
the list losing mail when the tray is closed, shows something else, or
another site is opened; the logs coming up over an open mail list;
anything on the page ending up under the tray.

**What cannot be tested by hand here:** I had no real server to send a
mail through. The journeys say what the main process says when one is
caught, on the channels it says it on.

## Risks and limitations

- Review: 2 passes; 10 findings fixed here, 2 settled by the
maintainer's decisions (below), 4 left as follow-ups. Details below.
- **Mail that arrives unseen shows nowhere** until the tray is opened.
See "Not in this pull request".
- **Mail kept from an earlier session cannot be cleared until the server
has run once.** See "What changes".
- Focus drops to the page when the app itself puts the terminal in place
of the mail while the focus is in the mail's tray. The logs and the
terminal already behave this way when one replaces the other.
- A row's hover is faint on the list's ground, the same weak surface the
logs are on.
- A clear that fails says nothing, as before.
- `toasts.spec.js:52` failed once in a full local run with "Cannot
fast-forward to the past" and passes on its own; it is the third time I
have seen it, it is not from this change, and it is flagged separately.

## Related

Part of #558, and the last of its three. Follows
#614. Mail HTML
rendering is unchanged and tracked separately.

---

<details>
<summary>Design decisions and alternatives considered</summary>

- **What the prototype lacks is kept and redrawn.** Its tray has a
title, "Clear emails" and a placeholder text: no list, no line for the
mail server, no dialog. The app has all three and keeps them, in the
tray.
- **A slot in the tray's heading**, filled by the open site while the
mail is what the tray shows, for what is done to the whole of what the
tray holds. The tray's heading is the window's, and the list is a
site's.
- **The dialog is left exactly as it is**, old components and all, so
that this change and the one that redraws how a mail is shown do not
meet in the same file.
- **The logs give way to everything, not only to the terminal.** One
rule for "the app asks for the logs" that does not have to know what
each tray is for: they never take a tray from under someone.
- **The count stays the design system's badge**, one line tall by losing
its vertical padding, and not a smaller drawing of my own.

</details>

<details>
<summary>Review outcome (required — see AGENTS.md)</summary>

**Pass 1: 7 [fix here] · 5 [follow-up]. Pass 2 (on the fix-up): 3 [fix
here] · 1 [follow-up]. 10 fixed here (7 and 3, one of pass 1's being a
follow-up applied here), 2 settled by the maintainer's decisions, 4 left
as follow-ups.**

- **Review:** completed — a separate agent context, read-only; head
`b9b7daa` / base `351d34b`; lint and the two unit files run, the
journeys read and not run; 7 [fix here], 5 [follow-up].
- Fixed: the check that the mail is nowhere but the tray ran before the
list had loaded and could not fail; the details journey guarded on a
margin of my own and not on the app's boundary, and read it before the
page was at its top; the count on the Logs button was drawn under the
next button when that was pressed, and its comment was wrong; the step
that leaves an open mail list where it is did not read that the page
says where the lines are; one journey needed a page longer than the room
above a tray at its first height; the check that the tray covers nothing
read the last card and not what ends the page.
- Applied here though marked follow-up: who a mail is from now gives way
before its subject in a narrow window.
- Decided by the maintainer: "Clear emails" stays disabled on an empty
list, as the prototype has it (one [fix here], recorded above as what it
takes away); no sign for mail that arrives unseen (one [follow-up], not
wanted).
- Follow-ups left: focus when the app swaps the tray from under it; the
row's faint hover; a failed clear that says nothing.
- **Review:** completed — a second separate agent context, read-only;
`b9b7daa` plus the fix-up as staged, before it could be committed (it is
`09ab94d`), base `351d34b`; lint and the two unit files run, each fix-up
traced, every journey that depends on the page's length listed; 3 [fix
here], 1 [follow-up].
- Fixed: a rule and its comment left from the heading the mail had on
the page; a comment that said who a mail is from gives way first, which
the rules did not do (they do now); a comment in the details journey
that did not say what its loop does.
- Follow-up left: a comment in the mail dialog's file still says the
list is under "Mail". The dialog is not touched here.
- Nothing found: the seven fix-ups, the journeys' absences, the other
journeys against a shorter page, the screenshot script.
- **Since review:** `b9b7daa → 09ab94d` is the two passes' fixes; the
second pass's three are not reviewed again, and are a deleted rule, one
flex value and comments. Lint, `npm test`, `npm run test:electron`, all
113 journeys, the affected journeys at three smaller window heights and
with a slowed status read, and the packaged smoke were run on the tree
that became `09ab94d`, the journey suite before the second pass's three
fixes and the affected journeys after them.

</details>

<details>
<summary>Implementation notes</summary>

- New: `src/renderer/site-mail.cjs` (`smtpNote`, `noMailNote`,
`mailRow`), `src/renderer/components/mail-panel.jsx` (`MailPanel`,
`MailTrayActions`), `tests/unit/site-mail.test.cjs`.
- `src/renderer/components/bottom-tray.jsx`: `SiteTrayActionsFill` and
its slot in the heading. `src/renderer/tray.cjs`: the third tray and
`trayAfterReveal`'s rule.
- A mail's row is a native button in a list item, where it was a `div`
with a role and key handlers. Who a mail is from now gives way before
its subject does in a narrow window.
- `scripts/screenshots/shots.cjs`: the mail's shot is taken of the tray.
I ran that one shot to check the script and did not commit the image;
#561 retakes them all.
- The details journey reads both of its halves part of the way down the
page, where a column that is held is not yet pushed by the end of the
cards, and guards on the app's own boundary: the details fit until they
are taller than the page, which is 24px less than nothing to spare under
them.
- Local checks on macOS: `npm run lint` clean, `npm test` and `npm run
test:electron` pass (1948 tests), `npm run test:e2e` 113 pass, `npm run
test:e2e:packaged` 15 pass.

</details>

<details>
<summary>Screenshots or recording</summary>

Not attached: I have no way to upload images from the command line. The
steps under "Worth a look by hand" show everything that changed.

</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
zaerl added a commit that referenced this pull request Oct 5, 2026
## Why

#542 replaces the app's interface with the one in the
[prototype](https://github.com/jameskoster/wordpress-contributor-toolkit-prototype),
drawn with the WordPress Design System. It was built in slices on
`redesign/wpds`, so that trunk, which releases are cut from, never held
a half-redesigned window. The window is whole now: the shell, the page
header and details, every card and dialog, and the tray. This pull
request is how the branch reaches trunk.

It lands before the last three sub-issues, on purpose. The settings
dialog (#559) and dark mode (#560) add to a finished window and do not
need a branch to hide in, and the guide (#561) is easier to rewrite
against what is on trunk. They follow as pull requests against trunk.

## What changes

Everything `redesign/wpds` holds; this pull request adds nothing of its
own. Each slice was reviewed in its own pull request against that
branch, and says there how to test it and what it leaves out.

- **The shell** (#555): a sites list, the page area and a footer, in a
larger window. #590
- **The page header and the details** (#556): the site's menu in the
header, and what the checkout is in a sidebar that can be put away.
#594
- **The site's page** (#557): the server and the build watch in the
header and the details
(#595); the ticket
card, the apply card with a preview dialog, and the list of a site's
tickets (#596,
#597,
#599); the
create-site, rename and delete dialogs
(#600,
#601);
confirmations as notices in the window's corner
(#602); the page's
notices, update card and setup checklist
(#605); the
terminal, logs, mail and the review dialogs painted with the design
system's tokens
(#606,
#608); and lint
rules that keep it so
(#609,
#610).
- **The tray** (#558): along the bottom of the window, holding the
terminal, the logs or the mail, with a count of unseen debug.log lines
on the footer
(#612,
#613,
#614,
#615).
- Along the way:
#611 (the site
menu's update item says why it is held), and three that tidy up before
landing: #616 (a
journey's race with the page's clock),
#617 (comments the
finished redesign made untrue) and
#618 (the server's
button by its present name in `AGENTS.md`).

**What a contributor will notice first:** the terminal, the logs and the
mail are no longer on the page but behind three buttons at the foot of
the window; the terminal is dark text on light; the server and the build
watch are started from the header; a patch is previewed in a dialog
before it is applied; and what worked is said in the window's corner.

**Not in this pull request:**

- The settings dialog (#559). Until it, nothing about how the window is
arranged is remembered across restarts: the details, the tray's height,
the apply card's fold.
- Dark mode (#560). The terminal reads its colours once, when it is
made, and will need to follow the theme.
- The user guide and its screenshots (#561), which describe the old
interface. They are published from release tags, so they are not wrong
until a release ships this; #561 is next, ahead of #559 and #560, for
that reason.
- How a mail is drawn, and how the window handles a link. Both are
unchanged and tracked separately.

## How to test this

Platforms: macOS and Windows, both. Buildkite builds signed artifacts
for this pull request; use the build for its current head, and check
that it is: a push to the branch makes earlier builds stale.

The suite, from the repository root, after `npm ci`:

```
npm run lint
npm test
npm run test:e2e
```

113 journeys walk every slice on macOS and Windows on each push. What
they do not do is run a real site: a clone of `wordpress-develop`, an
install, a build and a server are stood in for. The one test that does,
`real-setup.yml`, is run by hand and was run on this branch at `548c020`
(https://github.com/WordPress/contributor-toolkit/actions/runs/37298667056):
a Core site on macOS and on Windows and a Gutenberg site on macOS were
created, installed, built and served, and passed. **The Gutenberg site
on Windows did not finish.** Its first attempt was cancelled after 74
minutes inside the journey, a minute short of the limit that would have
failed it with evidence, so it says nothing about where it was; a second
attempt was still running when this was written and its result is not in
this description. The commits since `548c020` change a journey, comments
and prose.

**A pass by hand, on a real machine** (any platform; Apple Silicon for
the server, which no test on a pull request starts for real). It follows
the order a contributor meets things in:

1. Open the app with no sites. **Create new site**, a Core site, in a
folder with a space in its path. The setup checklist runs its steps; the
terminal's button at the foot of the window shows what each is doing.
2. Let the checklist's last step start the server, and finish
WordPress's own setup in the browser. Back in the app the header says
"Server running" and "Build watching". Stop the server and start it
again: from **Server running** in the header, or with **Stop** and
**Start** beside "Server" in the details.
3. Press the three buttons at the left of the footer in turn. Terminal:
type `help`. Logs: the server's lines, the build watch's, and Debug.log.
Email: where SMTP is listening. Drag the tray's top edge.
4. Link a ticket by its number. The card shows the ticket and its pull
requests and patches.
5. Apply one of them. The preview dialog names the files; **Apply and
rebuild** runs the steps on the card.
6. Edit a file under `src/`, then **Review & submit changes**. The diff
is the edit and nothing else.
7. Create a second site, or open one from before, and move between the
two from the sites list. Each has its own terminal, logs and mail.
8. **Update to latest trunk** from the site's menu.

**What must not have happened:** work lost in a link, an apply, a switch
or an update that did not say so; `node_modules` rebuilt where nothing
changed; a failure said only in a tray that stayed closed; one site's
output in another's tray; anything on the page under the tray.

**What cannot be tested by hand, and what was not:** none of the slices'
manual steps were run by a person. I looked at screenshots and drove the
app through the journeys; everything local was on macOS, with Windows
left to CI. This pass is the first one by hand.

## Risks and limitations

- **It is one commit on trunk**, since the repository allows only squash
merges. The slices' pull requests are its record. `redesign/wpds` should
not be branched from after this: it will have diverged from trunk.
- **Reviewed in slices, not as a whole.** Twenty-two pull requests, all
but a two-word change to `AGENTS.md` reviewed by a separate reviewer
context before they were opened, most in two passes; see below. The
branch was then swept once for what falls between slices, which found
comments and one unread field
(#617) and the
three points that follow.
- **Three questions and two failures still use the system's own
dialogs**: the discards ask through its confirm box, and a path that
could not be copied and a server started before there is a build are
said in its alert. #557 meant to replace them and did so for deletions
only.
- **Some dialogs are repainted, not rebuilt.** The review dialog and its
destinations, the mail dialog and the question an update asks about
loose edits have the design system's colours and type on the old
component library's parts.
- **A real Gutenberg setup on Windows is not shown to pass on this
branch.** See "How to test this". It passed on trunk before the
redesign, in 35 minutes; here it was past 46 on its second attempt.
Whether that is the runner or the branch is not known.
- **The guide describes the old interface** until #561. Do not cut a
release before it.
- **The bundle roughly doubled**
(#590): the sites
list brings `DataViews` and what it needs. Launch time was not measured.
- **Less is always in view.** A build's output, a new line in debug.log
and a caught mail are in a tray that may be closed. A failure opens the
terminal, or the logs if nothing else is open; unseen debug.log lines
are counted on the footer; a mail that arrives shows nowhere until its
tray is opened, which was decided and is not an oversight.
- **Translation is about half done.** The shell, the cards, the tray and
most dialogs go through the translator. Roughly 200 strings in
components and hooks do not yet (the review dialog and its destinations,
the setup checklist, the logs, most of what the hooks say), nor about
150 in the modules they take sentences from. Strings that are new are in
English in the shipped translations until they are translated.
- **Focus is lost in a few places**: when the app swaps what the tray
holds from under it, when a notice with a focused button goes, when a
row's own action removes the row.
- **Some failures are still worded by the main process** ("Error
invoking remote method…"): a failed rename, a failed setup.
- **Things carried over, not made by this:** a start that throws leaves
the server's button dead until a restart; erasing typed input in the
terminal breaks once the line wraps; a line written to debug.log while
it is being attached to can be shown twice.
- **#571 and
#603 will conflict
with trunk after this**, in the mail's journey and helpers and in the
dev server's hook.
- Each slice's own list has more, and says which of its limits were
chosen.

## Related

Closes #557. Closes #558. Part of #542, which stays open for #559, #560
and #561. #555 and #556 are closed already.

---

<details>
<summary>Design decisions and alternatives considered</summary>

- **An integration branch, and one landing.** A window drawn half by the
old view and half by the new one could not be released, and the slices
were too many to hold back one by one behind a flag. Fixes and changes
with no visible effect went to trunk first and were merged across, so
this diff is the redesign and little else.
- **Landing before #559 to #561.** The plan was to land when all seven
sub-issues were in the branch. The remaining three do not change what is
there: two add to it and one documents it. Holding a finished window on
a branch for them only lengthens the time trunk and the branch can drift
apart.
- **What the prototype lacks is kept and redrawn**, and what it has
somewhere else moves to where it puts it. Its labels are adopted. Where
a slice departs from it, the slice says so.

</details>

<details>
<summary>Review outcome (required — see AGENTS.md)</summary>

**No review of the whole diff was run. The record is the slices':
twenty-two pull requests into `redesign/wpds`, each but one reviewed
before it was opened by a separate, read-only reviewer context following
`.github/instructions/code-review.instructions.md`, most in two passes
(the change, then its fix-up), with the counts and the findings in each
pull request's own review outcome. The one is
#618, two words in
a line of prose.**

- **Review:** completed, per slice —
#590,
#594 to
#602,
#605,
#606,
#608 to
#617 (no review was
run for #618);
everything marked to fix in a slice was fixed in that slice, and what
was left is in its Risks.
- **Review:** completed, for leftovers only — a separate agent context,
read-only; `redesign/wpds` at `548c020` against trunk; not a review of
correctness, which the slices had: a search for dead CSS and code,
comments that waited for a slice that has landed, what is left of the
old component library and of the system's dialogs, strings not yet
translatable, and repository docs that name the branch. Nothing found in
the stylesheet, the dependencies or the docs; thirteen comments and one
unread field, fixed in
#617; the rest is
in Risks above.
- **CodeRabbit:** not run. Its check reads "Review skipped: automatic
reviews are disabled" on this pull request and on the slices, so the
slices' pre-PR reviews are the reviews of record, each for the head it
names.
- **Since review:** nothing was added to the branch outside a reviewed
slice, apart from three merges of trunk (`da19ac6`, `3344172`,
`23d46e7`).

</details>

<details>
<summary>Implementation notes</summary>

- `git diff origin/trunk...origin/redesign/wpds`: 148 files, about
14,800 lines added and 3,000 removed; about 6,300 of the added lines are
tests.
- The site's view, which was one component of five thousand lines, is
spread over the four regions the layout has: the header, the cards, the
details and the tray. Decisions are in `src/renderer/*.cjs` with unit
tests; components draw them.
- New for the suite: journeys per region under `tests/e2e/journeys/`,
lint rules of the repository's own (`eslint-rules/`), and Stylelint over
the window's stylesheet.
- The main process changed in one place for the redesign's sake: the
debug.log tail says which lines the file already held
(#614).

</details>

<details>
<summary>Screenshots or recording</summary>

Not attached: I have no way to upload images from the command line. The
prototype shows the design; the signed build shows the app.

</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
@zaerl zaerl added this to the v2.0.0 milestone Oct 7, 2026
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