Design localization support for automation interface manifest copy

Open
#434 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Domain
localization

Research direction

Start with the AUTOMATION_INTERFACE context and read OpenHands/OpenHands#16222 for the consumer implementation and review discussion. Compare the three manifest-copy designs, then document a versioned choice covering locale fallback, host and extension ownership, old-manifest compatibility, and a non-English Canvas test plan. Done means the cross-repository design is agreed before literals become authoritative.

Written by the indexing model from the issue text.

Description

Context

OpenHands/OpenHands#16222 makes Canvas automation UI copy (navigation labels, list/detail/edit titles, field labels and help) come from AUTOMATION_INTERFACE in this repository. The production manifest currently supplies English literals. Once published, those literals override Canvas t(...) calls and regress the existing localized UI to English.

Problem

The interface manifest needs to describe automation-owned copy without taking locale selection away from the host application. The current literal-string contract cannot represent that safely.

Desired outcome

Agree on a versioned manifest-copy design that:

  • preserves host locale selection and existing Canvas translations where available;
  • lets extensions own new or automation-specific copy without coupling Canvas rendering to a particular domain;
  • has a clear default/fallback locale;
  • has an admission/compatibility strategy for old manifests and hosts; and
  • can be tested with at least one non-English locale in Canvas.

Design directions to evaluate

  1. Stable translation message IDs, resolved by the host with a fallback supplied by the manifest.
  2. Locale maps in the manifest, with a well-defined fallback-chain and validation rules.
  3. Manifest literals as default-language fallback only, while the host keeps its translated values for known UI concepts.

This needs a cross-repository design before enabling manifest literals as authoritative UI copy. See OpenHands/OpenHands#16222 for the consumer implementation and review context.

Dominant language
Python
Stars
184
Forks
137
Avg merge
1d 19h
Merged PRs (30d)
46

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenHands/extensions

All issues in OpenHands/extensions

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.