Skip to content

Update the docs for 2.1.0, and retake the screenshots that predate the redesign - #777

Merged
ryanwelcher merged 4 commits into
trunkfrom
update/775-docs-for-2-1-0
Nov 17, 2026
Merged

ryanwelcher merged 4 commits into
trunkfrom
update/775-docs-for-2-1-0

Conversation

@ryanwelcher

@ryanwelcher ryanwelcher commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

Why

2.1.0 changes several flows the user guide describes, and some pages and screenshots still showed the window from before the 2.0.0 redesign (#591): the ☰ More menu, the "Open directory in" menu under the path, the Mail panel, the "compact action bar", Share feedback at the top of the sidebar.

What changes

Not in this PR: setup-wizard.png. It's a live-tier shot, so a person has to drive the app while it's taken: npm run shots -- --tier=live --only=setup-wizard from the repository root, on macOS.

How to test this

Platforms: any. This changes only docs and the screenshot harness. No app code changes.

Starting state: this branch checked out, with npm install run at the repository root.

  1. Run cd docs && npm ci && npx vitepress build. Expected: the build completes. VitePress fails a build that has a dead link.
  2. Run npx vitepress preview in docs/, and open Managing sites, Opening the site in your editor, Settings and Step debugging with Xdebug. Expected: each page's screenshot matches what the text describes, and Settings shows Theme with Light, Dark, System and Custom.
  3. With the current app open beside it, follow Your first contribution in Getting started. Expected: every control the steps name is on screen under that name.
  4. From the repository root, run node scripts/screenshots/capture.cjs --only=settings-dialog and then --only=xdebug-setup-menu. Expected: both pass and leave git status clean.

What must not have happened:

  • No page still names ☰, More, Open directory in, DB inspect (Adminer), the Mail panel or Share feedback. Check with grep -rn "☰\|More\*\* menu\|Open directory in\|DB inspect\|Share feedback" docs/guide README.md, which should print nothing.
  • The retaken screenshots show no real user path. They all show /tmp/wpct-docs-fixture/….

Risks and limitations

  • setup-wizard.png is still from 12 August (see above).
  • Em-dashes that were already in sentences I edited are left as they were, to keep the diff small. New lines use colons, so settings.md and setup-wizard.md each have one list bullet in a different style from its neighbours.
  • Review: 7 [fix here] · 0 [follow-up], all fixed. Details below.

Related

Fixes #775


Review outcome (required — see AGENTS.md)
  • Review: completed. Fresh agent context, run against .github/instructions/code-review.instructions.md, on head d0464b9 / base edbbb94 (trunk). npm run lint passed. npm test: 2309 pass, 0 fail, 9 skipped.
    • Architecture, security, performance, cross-platform: no findings.
    • 7 [fix here], all fixed:
      1. Getting started step 3 pointed at the details' Start button, which isn't there until the wizard is finished.
      2. The Database link was said to be in the header's server menu.
      3. Initialized was said to follow the clone, when it follows the install.
      4. Changed files was described as one of the details rows, when it's a separate section below Server and Build watch.
      5. A "server URL" was said to appear under Server, when what's there is View site.
      6. A stale "More menu" alt text was left in trunk-updates.md.
      7. The Settings shot waited for the label rather than for the control to be enabled.
    • 2 style notes, both applied: the Xdebug shot now uses the fixture's exported SERVER_URL / SMTP_PORT, and its stand-in server start now sends the mail server message too.
  • Since review: d0464b9 → 28409d0. The only changes are those fixes, which I checked line by line. Lint passes again, the docs build, and both affected shots retake to identical images.
  • Since then: 28409d0 → a4e137f, three docs-only commits. c84912a corrects when editor detection runs in editors.md. 747a7fe adds a sentence to trunk-updates.md for Fix a false "Update incomplete" banner after carrying work onto a ticket #770: the Update incomplete banner now shows on every branch of a site, since they share one build. a4e137f adds the Linux .deb and .rpm from Build and release deb and rpm packages for Linux #783 to Install the app in getting-started.md. The docs build.
Implementation notes
Screenshots or recording

The retaken shots are in docs/public/screenshots/. GitHub's file view shows each one's before and after.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Nov 13, 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

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
  • Autofix · 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

@ryanwelcher
ryanwelcher merged commit 6a4df96 into trunk Nov 17, 2026
17 checks passed
@ryanwelcher
ryanwelcher deleted the update/775-docs-for-2-1-0 branch November 17, 2026 18:39
ryanwelcher added a commit that referenced this pull request Nov 17, 2026
## Why

First beta of 2.1.0. 25 commits have reached trunk since `v2.0.0`, the
last one being the 2.1.0 docs update (#777). `electron-builder` names
the artifacts after the version in `package.json`, so the version has to
move before the tag and the artifacts exist. This is a beta, so it does
not take `releases/latest`.

## What changes

- The version moves from `2.0.0` to `2.1.0-beta.1` in `package.json` and
both root fields of `package-lock.json`. No dependency versions change.
- `npm run i18n:download` refreshed `src/languages/`. Five locales reach
80% for the first time and now ship: `bcc`, `de`, `es`, `ja` and
`zh-cn`. The other ten were updated.
- `build.electronLanguages` gains the Chromium locales those catalogs
need: `de`, `es`, `ja`, `zh-CN` and `zh_CN`.

| Locale | Translated | Strings |
| --- | --- | --- |
| bcc | 95% | 1109 |
| cs | 89% | 1036 |
| de | 100% | 1158 |
| en-ca | 90% | 1049 |
| en-gb | 100% | 1158 |
| es | 100% | 1158 |
| gl | 100% | 1158 |
| hu | 90% | 1051 |
| ja | 95% | 1109 |
| lo | 90% | 1049 |
| nl | 100% | 1158 |
| pl | 94% | 1096 |
| sr | 100% | 1158 |
| tr | 95% | 1111 |
| zh-cn | 100% | 1158 |

Chromium locales kept (build.electronLanguages): en-US, cs, de, en-GB,
en_GB, es, hu, ja, nl, pl, sr, tr, zh-CN, zh_CN

## How to test this

Platforms: any for the checks below. macOS and Windows for the signed
artifact checks in `RELEASING.md` section 2, which run on this PR's
Buildkite build before the merge.

Run from the repository root:

1. `node -e "console.log(require('./package.json').version)"` prints
`2.1.0-beta.1`.
2. `python3 -c "import
json;d=json.load(open('package-lock.json'));print(d['version'],
d['packages']['']['version'])"` prints `2.1.0-beta.1 2.1.0-beta.1`.
3. `git diff origin/trunk...HEAD -- . ':!src/languages'` shows only the
three version lines and the `build.electronLanguages` list.
4. `npx electron . --lang=de` opens the app in German. Repeat with `es`,
`ja` and `zh-CN`; each shows that language, not English.

**What must not have happened:** no dependency version changes in
`package-lock.json`, and no locale that shipped in 2.0.0 is missing from
`src/languages/`.

## Risks and limitations

**Southern Balochi (`bcc`) ships as a right-to-left catalog.** Its
catalog sets `text direction` to `rtl`, but `bcc` is missing from
`RTL_LANGUAGES` in `scripts/download-translations.cjs`, so the script
did not hold it back. Choosing Baluchi in Settings, or an OS that
reports `bal`, gives a half-mirrored window. Kept on purpose for this
beta; the script fix should land before 2.1.0.

The translations come from translate.wordpress.org as they stand today.
Strings below 100% fall back to English.

## Related

Part of the v2.1.0 milestone. The `bcc` fix is tracked in #787.

---

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

1 [fix here] · 1 [follow-up]. Neither fixed in this PR.

- **`bcc` is a right-to-left catalog that was not held back**
(`src/languages/bcc.json`, `scripts/download-translations.cjs:48`). Kept
for the beta by the release manager's decision. The fix is to add `bcc`
to `RTL_LANGUAGES` and re-run `npm run i18n:download` before 2.1.0.
- **Follow-up:** the script could also hold back any catalog whose own
`text direction` entry is `rtl`, so the next right-to-left locale is not
missed the same way, with a case in
`tests/unit/download-translations.test.cjs`.

Checked with nothing to report: the diff outside `src/languages/` is the
three version lines plus `build.electronLanguages`; that list matches a
fresh calculation from the catalogs; the new catalogs have the same
shape as the existing ones and pass `resolveCatalog`; placeholders and
HTML tags match the source strings in all 15 catalogs. An older Czech
string leaves out `%2$s`; it predates this branch and is fixed on
translate.wordpress.org, not here.

- **Review:** completed; separate-context subagent; reviewed head
`1b58aeb` / base `6a4df96` (trunk); `npm run lint` clean, `npm test`
2312 pass, 0 fail, 9 skipped; outcome above.
- **Since review:** none.

</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)
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.

Update the docs for 2.1.0, and retake what predates the 2.0.0 redesign

1 participant