docs(FR-2535): update header docs with session timer and menu corrections#6573
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has required the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
nowgnuesLee
left a comment
There was a problem hiding this comment.
Review: PR #6573 — docs: update header docs with session timer and menu corrections
Summary
This PR fixes a significant amount of untranslated/broken text across JA and TH header docs (e.g., Top Bar 機能s, 管理者istrator, ผู้ดูแลระบบistrator), adds the new Login Session Timer and Responsive Layout sections to all 4 languages, corrects heading title casing in EN, bolds menu item names per the style guide, and removes a sentence fragment in EN Notification. Overall quality is good — menu labels match the i18n source of truth and structural parity across all 4 languages is maintained.
Findings
[File: src/en/header/header.md]
No issues. Heading title case fix, bolded menu items, added :::note admonition for session timer — all follows the documentation style guide correctly. The sentence fragment "When the background task is finished." removal is a good catch.
[File: src/ja/header/header.md]
[i18n / Correctness] Nice to Have: The JA i18n label for "Preferences" is "環境設定" (webui.menu.Preferences), and the docs correctly use "環境設定". The field label descriptions (Original password, New password) were previously untranslated English and are now properly translated — nice improvement.
[Correctness] Nice to Have: The 2FA Enabled references in backticks remain in English across all languages. The actual JA UI label is "2要素認証が有効" per resources/i18n/ja.json. This is a pre-existing pattern and acceptable in backtick context, but worth noting for a future pass to align with what users actually see in each locale.
[File: src/ko/header/header.md]
No issues. Labels match i18n files. "설정" for Preferences, "사용자 정보 변경" for My Account, "로그 / 에러기록" for Logs/Errors — all verified against resources/i18n/ko.json.
[File: src/th/header/header.md]
[Code Hygiene] Nice to Have: Line 85 in the current file (the "My Account" form field list) still uses UPDATE in English: "คลิกปุ่ม UPDATE เพื่ออัปเดตข้อมูลผู้ใช้". The EN version also says "UPDATE" so this is consistent, but the actual button label may have been localized in the UI. This is pre-existing and not a blocker.
Recommendation
LGTM. The PR correctly translates previously broken/untranslated content in JA and TH, adds new sections with structural parity across all 4 languages, and menu labels are verified against the i18n source files. Style guide compliance is good (title case headings, bolded field names, admonition usage). No must-fix issues found.
e9ad2f4 to
316a216
Compare
0c72ae9 to
e2540db
Compare
316a216 to
269a642
Compare
e2540db to
2bd36bf
Compare
2bd36bf to
edad7db
Compare
269a642 to
959bd09
Compare
edad7db to
32d2500
Compare
There was a problem hiding this comment.
Pull request overview
Updates the Backend.AI WebUI user manual “Top Bar / Header” documentation to reflect current header UI behavior, especially around the login session timer and the user dropdown menu, across all supported languages (en/ko/ja/th).
Changes:
- Update “Login Session Timer” text to describe the extend button as a repeat icon (instead of refresh).
- Rewrite the “User Menu” section to distinguish non-clickable user info from clickable action items and correct action item descriptions.
- Apply minor formatting adjustments (e.g., inline-code formatting for UI labels) across the translated pages.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| packages/backend.ai-webui-docs/src/en/header/header.md | Updates session timer icon description; rewrites user dropdown documentation; minor formatting tweaks. |
| packages/backend.ai-webui-docs/src/ko/header/header.md | Same functional doc updates for Korean translation. |
| packages/backend.ai-webui-docs/src/ja/header/header.md | Same functional doc updates for Japanese translation. |
| packages/backend.ai-webui-docs/src/th/header/header.md | Same functional doc updates for Thai translation. |
120593d to
83425aa
Compare
32d2500 to
7891fa2
Compare
7891fa2 to
cd1403c
Compare
83425aa to
68a0055
Compare
cd1403c to
f989516
Compare
68a0055 to
ace1668
Compare
f32e9ce to
da8a5f6
Compare
6008c9a to
5b6759c
Compare
5b6759c to
6e701a1
Compare
da8a5f6 to
4e4820e
Compare
This reverts commit d3ca954. #6575 was merged with base=main because `gt track --parent main` on a locally untracked branch caused Graphite to record main as its parent. The subsequent `gt submit --publish --force` pushed this base change to GitHub, and the PR was then squash merged, collapsing 29 commits from 6 stacked PRs into a single commit on main: - #6570 docs(FR-2532): share_vfolder labels - #6571 docs(FR-2533): user_settings - #6572 docs(FR-2534): 2FA/TOTP/SSO login - #6573 docs(FR-2535): header session timer & menu - #6574 docs(FR-2536): Start From URL & announcement banner - #6575 docs(FR-2537): dashboard board customization & auto-refresh Reverting so each PR can be merged in its original stack order. After this revert merges: - #6575 will be reopened with its original base (#6574's branch) - #6625's base will be restored to #6611's branch - The other open PRs (#6570, #6571, #6572, #6573, #6574) retain their original bases and will be mergeable in stack order
Merge activity
|
…ions (#6573) Resolves #6679 (FR-2535) ## Summary - Add **session timer** documentation showing remaining session time in the header - Correct menu item descriptions in the user dropdown (user info, preferences, logs, etc.) - Document all items visible in the user dropdown menu including "About Backend.AI", "My Account", "Preferences", "Logs / Errors", and "Download Desktop App" - Apply reviewer fixes ## Changes - `header/header.md` (en/ko/ja/th): session timer section, corrected user dropdown menu item descriptions ## Test plan - [ ] Verify session timer display matches the actual header UI - [ ] Verify all dropdown menu items are listed accurately 🤖 Generated with [Claude Code](https://claude.com/claude-code)
6e701a1 to
67ab610
Compare
4e4820e to
14ce31c
Compare

Resolves #6679 (FR-2535)
Summary
Changes
header/header.md(en/ko/ja/th): session timer section, corrected user dropdown menu item descriptionsTest plan
🤖 Generated with Claude Code