Skip to content

docs: add the terminal demo components to DESIGN - #22

Merged
showxu merged 1 commit into
masterfrom
docs/terminal-demo
Oct 23, 2026
Merged

showxu merged 1 commit into
masterfrom
docs/terminal-demo

Conversation

@showxu

@showxu showxu commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Summary

DESIGN gains the terminal components that the github-readme-design toolchain needs to render a CLI's Quick look, so member CLIs can commit recorded terminal demos.

  • Components: terminal, terminal-frame, terminal-title-bar, terminal-prompt and terminal-command, each with a -dark override. They use the existing palette: the surface color with muted ink for output, the neutral title bar, the hairline line frame, violet prompts and ink commands; the dark appearance takes the matching dark tokens. Corners use rounded.md.
  • Typography and spacing: typography.terminal is JetBrains Mono 14/21 from the bundled fonts; spacing adds the terminal padding, title bar height, minimum width and a 1px hairline.
  • Layout: a Terminal demo entry describes the card.

Validation

  • DESIGN lint: zero errors, zero warnings.
  • profile check passes.
  • Apple CLI's recorded session renders in light and dark and terminal check matches.

@showxu
showxu merged commit 974fa25 into master Oct 23, 2026
3 checks passed
@showxu
showxu deleted the docs/terminal-demo branch October 23, 2026 18:05
showxu added a commit to computer-mcp/apple-cli that referenced this pull request Oct 23, 2026
## Summary

This repository adopts the organization's shared standard:
[computer-mcp/github-workflows](https://github.com/computer-mcp/github-workflows)
for CI and source policy, the README first screen, and the presentation
assets in `.github/assets/`.

- **Assets:** `.github/assets/logo/logo-light.png` and `logo-dark.png`,
matching the digests recorded in the organization's icon provenance, and
`.github/assets/social-preview/social-preview.png`.
- **Terminal demo:** `.github/assets/terminal/` holds `script.yml`, the
recorded `recording.json` and the light and dark SVGs, recorded against
a fresh build and rendered from the organization's terminal components
([computer-mcp/.github#22](computer-mcp/.github#22)).
The session prints the version and previews a notification as JSON
without accessing app data or sending it.
- **Brand retirement:** the old README header images, `.github/brand/`,
the brand sync rule in AGENTS and the brand CI job are removed.
- **CI:** a `demo` job re-records the terminal demo with the shared
`terminal-demo.yml` against the CLI in the candidate archive that
`package` builds, comparing only `recording.json`; `validate` aggregates
`package` and `demo`; the release workflow drops its cache and its
concurrency group, so running and queued releases are kept. A separate
`Source policy checks` workflow enforces MAINTENANCE at `.github`
`5c54a40`, and every shared workflow is pinned to `53ecce5`; its one
path exception, `Tests/ReleaseTools/test_public_content.py`, holds
synthetic machine paths for the public-content check and is documented
in CONTRIBUTING.
- **Layout:** `Scripts/` → `scripts/`, with every reference updated;
Swift keeps `Sources/`, `Tests/` and `Documentation/`.
- **README:** the centered logo, name, About sentence, badges and
navigation, then Overview, the terminal Quick look, Install, Usage,
Targets, MCP, Requirements, Documentation, Contributing and License.
Install now states that no release has been published yet and that
Homebrew and the release archive apply from the first release. Short
copy no longer carries the target count.

After the checks have run here, the `default branch` ruleset should
require exactly `policy / policy` and `validate / validate`; `validate`
covers the jobs it requires today. The social preview is uploaded in
repository settings after merge.
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