Skip to content

docs(localization): document translate CLI key extraction#2247

Open
spike-rabbit wants to merge 1 commit into
mainfrom
docs/translate-cli-localization
Open

docs(localization): document translate CLI key extraction#2247
spike-rabbit wants to merge 1 commit into
mainfrom
docs/translate-cli-localization

Conversation

@spike-rabbit

@spike-rabbit spike-rabbit commented Jun 29, 2026

Copy link
Copy Markdown
Member

Summary

Moves the update-translatable-keys CLI documentation out of the element-translate-ng package README and into the real localization documentation.

  • Adds an Extracting translatable keys subsection to docs/fundamentals/localization.md, covering the update-translatable-keys command and the element-translate.conf.json config schema.
  • Clarifies that the CLI ships as the separate @siemens/element-translate-cli package (including the dev-dependency install step).
  • Trims the duplicated CLI/config content from projects/element-translate-ng/README.md, replacing it with a short paragraph linking to the docs section.
  • Fixes a typo in the config field name (locationsPrefix -> locationPrefix).

Rationale

CLI tooling documentation belongs in the maintained docs site rather than a package README, where it is easier to discover and keep up to date.


Documentation.
Examples.
Dashboards Demo.
Playwright report.

Coverage Reports:

Code Coverage

@spike-rabbit spike-rabbit requested review from a team as code owners June 29, 2026 14:57

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request centralizes the documentation for extracting translatable keys by moving it from the element-translate-ng README to the main localization fundamentals guide, updating it to reference the new @siemens/element-translate-cli package. A review comment correctly identifies a typo in the configuration example's glob pattern, where '@simpl' should be corrected to '@siemens'.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/fundamentals/localization.md Outdated
Move the update-translatable-keys CLI usage and config documentation
from the element-translate-ng README into the localization docs and
note that the CLI ships as the @siemens/element-translate-cli package.
@spike-rabbit spike-rabbit force-pushed the docs/translate-cli-localization branch from 4e7ad0b to 75b13cf Compare June 29, 2026 15:00

@michael-smt michael-smt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks!

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