Skip to content

Apply UX design principles for CLI help and console output accessibility - #1485

Merged
Zhenchao Ni (zhenchaoni) merged 2 commits into
mainfrom
ux/cli-console-feedback
Oct 21, 2026
Merged

Zhenchao Ni (zhenchaoni) merged 2 commits into
mainfrom
ux/cli-console-feedback

Conversation

@zhenchaoni

Copy link
Copy Markdown
Member

Summary

Apply UX feedback to the WinML CLI help page and console output.
Changes focus on presentation, readability, and accessibility.

UX principles

  • Do not use emojis. Use text such as "Done" or "In progress" to show progress.
  • Do not rely only on color or bolding to convey information or progress.
    For example, pair green with "Done", yellow with "In progress", and red
    with "Blocked" when those colors represent those states.
  • Consider line breaks when important information is densely packed and
    differentiated by color.
  • Use all caps only for acronyms and where required by official names.
  • Use visual sections to organize information.
  • Use sentence case for titles.

These principles are also recorded in CLAUDE.md.

Changes

Help page

  • Retain the logo and display the product name and version as plain text.
  • Remove redundant promotional text and the CPU/GPU/NPU banner line.
  • Place the introduction and documentation link before Usage.
  • Add periods to the shared verbose and quiet option descriptions.

Console output

  • Remove decorative emojis from setup, configuration, export, optimization,
    analysis, artifact, and EP installation messages.
  • Replace stage icons with explicit text:
    [In progress], [Done], [Skipped], and [Failed].
  • Replace analysis support-level emojis with meaningful text, preserving
    existing classifications.
  • Label build support counts as Supported, Partial, and Unsupported,
    displayed separately from the progress bar.
  • Split device details and analysis metadata onto separate lines.
  • Apply sentence case to affected titles and labels across sys, config,
    analyze, export, optimize, catalog, inspect, and perf.
  • Remove unnecessary capitalization from diagnostic and error messages.
  • Preserve existing visual sections and use color as supplementary information.

Regression coverage

  • Update assertions for changed output text.
  • Add coverage for text status rendering, device-detail line breaks,
    support labels, and 80-/120-column output.

Scope

No changes to model-processing logic, status decisions, progress calculations,
command exit codes, JSON output, or configuration schemas.

@zhenchaoni
Zhenchao Ni (zhenchaoni) requested a review from a team as a code owner October 20, 2026 08:59

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the PR diff at bbdb157. No blocking findings. Changes remain scoped to presentation and accessibility; status decisions, execution logic, and JSON output are preserved. Verified literal status labels, support counts, help ordering, and narrow-width coverage. Local validation: 752 tests passed, 1 skipped because OpenVINO EP is not installed; Ruff on changed Python files and git diff --check passed. All current PR checks are green.

@zhenchaoni
Zhenchao Ni (zhenchaoni) merged commit 167d66e into main Oct 21, 2026
9 checks passed
@zhenchaoni
Zhenchao Ni (zhenchaoni) deleted the ux/cli-console-feedback branch October 21, 2026 05:19
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.

2 participants