Skip to content

Lead the READMEs with the website's pitch, in each language's own screenshots - #187

Merged
sudoHG merged 5 commits into
mainfrom
readme-polish
Oct 13, 2026
Merged

sudoHG merged 5 commits into
mainfrom
readme-polish

Conversation

@sudoHG

@sudoHG sudoHG commented Oct 13, 2026 •

Copy link
Copy Markdown
Owner

Docs plus one optional screenshot test; no app code.

  • Both READMEs open with the website banner (links to the site), the website's pitch and three points, a bold download line (free, notarized, Apple silicon, macOS 14 or later) and the website link. Product name in prose is "Ask Key" / 请旨; identifiers (AskKey.dmg, data directory, keychain service) stay AskKey.
  • A large language badge under each title links to the other README (the English one shows 简体中文 through a URL-encoded shields.io badge, so README.md itself stays free of Chinese).
  • Permissions: describe the agent writes added in 0.3.0 (create, modify or delete a credential, set instructions and group, organize groups in one batch), each approved for that operation.
  • README.zh-CN.md now shows Chinese screenshots: assets/readme/approval-prompt-zh.png and assets/readme/agent-access-zh.png.
  • ScreenshotE2ETests.testReadmeScreensInChinese captures them in the optional screenshot run with ASKKEY_E2E_LANGUAGE=zh-Hans as 18-zh-approval-default and 19-zh-agent-access; scripts/e2e-report.py exports both, and docs/testing.md lists all 19 screenshots.

Image source

From the askkey-basic-ui-evidence artifact of CI run 38426263004: 18-zh-approval-default.png (300×364) and 19-zh-agent-access.png (980×652). Processed like the English images in #151: the Agent access window's empty 32 px bottom strip cropped to 980×620, and the corners outside the rounded window made transparent with the English images' own alpha. Synthetic data only.

Checks

  • python3 scripts/check_hygiene.py and python3 -m unittest discover -s Tests/Automation: passed.
  • CI run 38426263004: build-and-test and basic-ui-flows passed, and the optional screenshot run exported all 19 PNGs. scripts/run-e2e.sh was not run locally.

…ominent

The optional screenshot run also captures the approval prompt and the
Agent access page in Simplified Chinese, for README.zh-CN.md. Each
README now carries a large badge right under its title that links to
the other language.
@sudoHG
sudoHG merged commit 3a4e9b5 into main Oct 13, 2026
2 checks passed
@sudoHG
sudoHG deleted the readme-polish branch October 13, 2026 16:36
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