docs:uxw-localization-in-support - #268
Conversation
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe PR reorders UX writing documentation, adds a Localization category and tabbed pages, introduces localization guidance, updates explicit sidebar configuration and blog tags, adds ChangesUX writing localization documentation
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant Docusaurus
participant sidebars.ts
participant DocItemTabItemLayout
participant DocTabsHeader
Docusaurus->>sidebars.ts: resolve UX Writing navigation
sidebars.ts-->>DocItemTabItemLayout: provide sidebar category
DocItemTabItemLayout->>DocItemTabItemLayout: compute parent ID and tab list
DocItemTabItemLayout->>DocTabsHeader: pass resolved tabs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guidelines/language/support-and-resources/uxw-localization/overview.md`:
- Line 81: Replace the vague “here” link text with descriptive
destination-specific text in both
docs/guidelines/language/support-and-resources/uxw-localization/overview.md
(lines 81-81), using wording such as “IX brand theme repository,” and
docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx
(lines 433-433), using wording such as “Element design system language packs.”
Keep the existing URLs unchanged.
In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx`:
- Line 142: Correct the language name in the translation-testing guideline from
“Finish” to “Finnish,” leaving the rest of the sentence unchanged.
- Line 165: Update the sentence in the localization writing guidelines to
replace the ungrammatical “decrease than the original” phrasing with “are
shorter than the original,” preserving the existing meaning and surrounding
guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 46534bea-814e-456c-94a4-cc56733da403
📒 Files selected for processing (8)
docs/guidelines/language/support-and-resources/AI-and-UX-writing.mddocs/guidelines/language/support-and-resources/UX-writing-principles.mddocs/guidelines/language/support-and-resources/UX-writing-resources.mddocs/guidelines/language/support-and-resources/ux-writer-role.mddocs/guidelines/language/support-and-resources/uxw-localization/_category_.jsondocs/guidelines/language/support-and-resources/uxw-localization/index.mdxdocs/guidelines/language/support-and-resources/uxw-localization/overview.mddocs/guidelines/language/support-and-resources/uxw-localization/writing.mdx
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request reorganizes the sidebar positions of several UX writing guidelines and introduces a new "Localization" section, which includes an overview page and detailed writing guidelines. The reviewer's feedback primarily addresses adherence to the repository's style guide, specifically requesting the removal of Oxford commas across multiple files, ensuring sentence case is used in headings, and correcting a typo ("Finish" to "Finnish").
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.
…n/writing.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx (4)
239-261: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winUse the language name in the Chinese example.
希腊is the country name; the language name is希腊语. The current example contradicts the rule immediately above. (dict.revised.moe.edu.tw)- <li>希腊</li> + <li>希腊语</li>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx` around lines 239 - 261, Update the Chinese-language example in the “Provide user-friendly language selection” donts list to use the correct language name “希腊语” instead of the country name “希腊”, while leaving the surrounding examples unchanged.
62-80: 🩺 Stability & Availability | 🟠 Major | ⚡ Quick winUse Docusaurus admonition syntax
Both callouts use!!! info, which this Docusaurus setup doesn’t support. Replace them with:::info[...] ... :::so the blocks render correctly.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx` around lines 62 - 80, Replace the unsupported `!!! info "Meaning of the term title"` admonition in the terminology guidance section with Docusaurus `:::info[Meaning of the term title]` syntax, closing the block with `:::` while preserving its existing content.
218-237: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winMark the plural examples as illustrative, not complete rules
Several rows compress CLDR into suffix heuristics and omit
otherand fraction cases. Label them as examples or replace them with full CLDR categories so readers don’t treat them as implementation rules.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx` around lines 218 - 237, Update the plural-forms table under “Consider different linguistic rules” to clearly label its language-specific entries as illustrative examples rather than complete implementation rules. Preserve the existing examples, but add a concise qualification that they simplify CLDR behavior and may omit categories such as “other” and fraction handling.
199-213: 🩺 Stability & Availability | 🟠 Major | ⚡ Quick winEscape the literal placeholder braces in these MDX examples
The placeholder examples in the JSX and prose sections are parsed as MDX expressions; escape them as literal text (for example{'{count}'}) so the page renders correctly.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx` around lines 199 - 213, Escape the literal placeholder braces in the pluralization examples within “Use localization to handle pluralization,” including {count} and {rowName} in JSX list items and the conditional code example, using MDX-safe literal text so the documentation renders without evaluating them as expressions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guidelines/language/support-and-resources/uxw-localization/overview.md`:
- Around line 40-42: Update the locale-selection guidance near the
SiLocaleService reference to explicitly state that users can select and persist
their locale, correcting the sentence’s grammar while preserving its intended
behavior and example.
In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx`:
- Around line 324-327: Remove the duplicated “translation” in the “Provide UX
writing specifications” section so the sentence refers to “translation
libraries” once, preserving the rest of the guidance and links unchanged.
- Around line 199-201: Update the “Use localization to handle pluralization”
guidance to clarify that application code should pass the relevant count into
localization, while language-specific plural rules must not be hard-coded in
product logic or writing style. Replace the absolute claim that product code
cannot handle pluralization without changing the intended localization-based
behavior.
---
Outside diff comments:
In `@docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx`:
- Around line 239-261: Update the Chinese-language example in the “Provide
user-friendly language selection” donts list to use the correct language name
“希腊语” instead of the country name “希腊”, while leaving the surrounding examples
unchanged.
- Around line 62-80: Replace the unsupported `!!! info "Meaning of the term
title"` admonition in the terminology guidance section with Docusaurus
`:::info[Meaning of the term title]` syntax, closing the block with `:::` while
preserving its existing content.
- Around line 218-237: Update the plural-forms table under “Consider different
linguistic rules” to clearly label its language-specific entries as illustrative
examples rather than complete implementation rules. Preserve the existing
examples, but add a concise qualification that they simplify CLDR behavior and
may omit categories such as “other” and fraction handling.
- Around line 199-213: Escape the literal placeholder braces in the
pluralization examples within “Use localization to handle pluralization,”
including {count} and {rowName} in JSX list items and the conditional code
example, using MDX-safe literal text so the documentation renders without
evaluating them as expressions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 93c15383-6447-442b-93e8-f59e61037d07
📒 Files selected for processing (2)
docs/guidelines/language/support-and-resources/uxw-localization/overview.mddocs/guidelines/language/support-and-resources/uxw-localization/writing.mdx
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/theme/DocItem/Layout/index.tsx`:
- Around line 153-166: Update the first entry in the localizationTabs array to
use the label “Overview” instead of “Localization”; leave the second “Writing”
tab unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a9f86052-23d5-490f-bb5c-181c10fff2e6
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (6)
blog/tags.ymldocs/guidelines/language/support-and-resources/uxw-localization/overview.mddocs/guidelines/language/support-and-resources/uxw-localization/writing.mdxpackage.jsonsidebars.tssrc/theme/DocItem/Layout/index.tsx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/guidelines/language/support-and-resources/uxw-localization/overview.md
- docs/guidelines/language/support-and-resources/uxw-localization/writing.mdx
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
tokyojen
left a comment
tokyojen
left a comment
There was a problem hiding this comment.
All reviews were done regarding content by Kathrin and the UX writing team inside element markdown (code.siemens). The changes in formatting have been done and it is now ix design formatted. Ready to be merged and deployed.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/theme/Logo/index.tsx`:
- Around line 34-39: Move the accessible label from the wrapper div to the
surrounding Link, using alt or title only when navbarTitle is absent or empty so
the link retains its existing title-based name otherwise; remove aria-label from
the div and preserve the logo rendering and sizing.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: bae472d0-0c10-4e1a-b5b3-fe0ecf1c0762
📒 Files selected for processing (7)
docs/guidelines/language/support-and-resources/uxw-localization/writing.mdxsidebars.tssrc/components/BorderTable/index.tsxsrc/components/ColorTable/index.tsxsrc/pages/index.tsxsrc/theme/DocItem/Layout/index.tsxsrc/theme/Logo/index.tsx
💤 Files with no reviewable changes (3)
- src/components/ColorTable/index.tsx
- src/components/BorderTable/index.tsx
- src/pages/index.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
- sidebars.ts
kathrinschalber
left a comment
kathrinschalber
left a comment
There was a problem hiding this comment.
A few suggestions. Feel free to just resolve them if not applicable :)
Co-authored-by: Kathrin <123640803+kathrinschalber@users.noreply.github.com>
Co-authored-by: Kathrin <123640803+kathrinschalber@users.noreply.github.com>
Co-authored-by: Kathrin <123640803+kathrinschalber@users.noreply.github.com>
tokyojen
left a comment
tokyojen
left a comment
There was a problem hiding this comment.
I reverted the code files I accidentally changed. There are still 2 changes in index.tsx and sidebars.ts so please do a final check on these to make sure the current change is correct
4 participants
💡 What is the current behavior?
Creating new page for the "Support and resources" section called Localization
GitHub Issue Number: #
🆕 What is the new behavior?
This page has 2 tabs - Overview and Writing
👨💻 Help & support
Summary by CodeRabbit