docs(model-serving): capture endpoint detail ready-alert and replica-filter screenshots#7459
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes screenshot TODO placeholders in the model-serving user manual after the corresponding screenshots (endpoint_detail_ready_alert.png and replica_status_filter.png) were captured for all four locales. It is a small follow-up to PR #7443.
Changes:
- Removes two
<!-- TODO: Capture screenshot — ... -->HTML comments per locale, now that the referenced images exist. - Applied identically to en/ja/ko/th versions of
model_serving.md.
Reviewed changes
Copilot reviewed 4 out of 12 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md | Removes two screenshot TODO comments |
| packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md | Removes two screenshot TODO comments |
| packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md | Removes two screenshot TODO comments |
| packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md | Removes two screenshot TODO comments |
a9a6165 to
c26480f
Compare
47bc665 to
c5932db
Compare
c26480f to
18a71f6
Compare
18a71f6 to
c26480f
Compare
c5932db to
47bc665
Compare
ironAiken2
left a comment
There was a problem hiding this comment.
Review feedback (relayed from the reviewer).
Scope note: PR #7459 itself only captures
endpoint_detail_ready_alert.pngandreplica_status_filter.png. Most items below concern screenshots/prose introduced by the stacked content PR #7443 and should be addressed there; they are consolidated here because this is the top of the stack.
Screenshots
- Fig 13.21 (
endpoint_detail_private_alert.png) — the screenshot came out too dark/dim. Please recapture it with correct brightness. - Fig 13.22 (
endpoint_preparing_alert.png, the "Preparing your service" banner) — isn't this alert currently excluded/removed from the UI? This needs to be verified.
Section 13.3 "Serving Page Overview" / Fig 13.7
- The Serving page has been renamed to the Deployment page, and both its name and UI have changed. The section 13.3 text and Fig 13.7 (
serving_list_page.png) need to be updated accordingly.
Section 13.4 "Creating a Model Service"
- In the sentence "어느 시점이든 현재 리비전…", the word 현재 ("current") is rendered in italics (markdown
*현재*, KO line 286). It should not be emphasized as italic — this is also inconsistent with line 597, which uses bold (**현재**). - Create Deployment modal — the Korean doc renders the button as
New Deployment(KO line 290). For the Korean manual this must be localized to "배포 생성". - Fig 13.8 (
model_serving_create_modal.png) description:- The explanation for "목표 레플리카 수" (target replica count) is missing.
- The confirm button is "생성", not
Create Deployment(KO line 300 referencesCreate Deployment).
- Fig 13.9 (
model_serving_add_revision_modal.png) — the figure and the description below it do not match. The order should be: explain "Preset Mode for Revision Creation" and "Advanced Mode" first, then provide the field description for the case where Advanced Mode is selected. - "Service Launcher (Detailed Fields)" section is showing the old UI — Fig 13.10 (
service_launcher_command_mode.png) needs to be recaptured. - Fig 13.14 (
service_launcher3.png) and its description are written against the old UI. - Fig 13.16 (
cluster_mode.png) and its description are written against the old UI. - "Validating the Service" section — this content is from the old UI and is no longer provided in the current UI; it should be revised/removed.
ironAiken2
left a comment
There was a problem hiding this comment.
LGTM
As there are numerous additional changes to the deployment side, these will be addressed in the top-level stack.
Merge activity
|
…filter screenshots (#7459) > **Stacked on** #7443 (`docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish`). Follow-up polish that resolves the screenshot `TODO` placeholders introduced by #7443 in `model_serving.md`. No separate issue (small completion of #7443's own scope). ## Summary - Captured **`endpoint_detail_ready_alert.png`** and **`replica_status_filter.png`** from the live WebUI on a healthy deployment, in all 4 locales (en/ja/ko/th), at 2× zoom via `window.switchLanguage` per `SCREENSHOT-GUIDELINES.md`. - Removed the 2 corresponding `<!-- TODO: Capture screenshot — ... -->` comments in `src/{en,ja,ko,th}/model_serving/model_serving.md` (8 lines total). Image references and surrounding blank lines unchanged. ## Intentionally left as-is - **`endpoint_detail_shm.png` TODO kept.** The live Endpoint Detail Page has no "Service Info" card (it renders "Basic Information") and surfaces **no Shared Memory (SHM)** field for the available deployment (verified via DOM scan). Capturing it would require fabrication — and it signals a **doc↔UI mismatch** in #7443's prose that should be addressed in #7443, not faked here. - **Cross-reference `TODO` (Deployment Presets link) kept.** `deployment_presets.md` is added by #7444, which is stacked above #7443; restoring the link here would create a broken internal link. Belongs in #7444's scope. ## Notes for #7443 author - The ready-alert section describes a **"Start Chat"** button, but the actual UI button is **"Test in Chat"** (visible in the new screenshot). Prose-only fix, out of scope for this PR. ## Test plan - [ ] `src/{en,ja,ko,th}/images/endpoint_detail_ready_alert.png` and `replica_status_filter.png` render in the manual. - [ ] Each locale's screenshot shows that locale's UI strings. - [ ] Only the SHM + cross-reference TODOs remain in `model_serving.md`. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
47bc665 to
39db375
Compare
c26480f to
cdaca8c
Compare

Follow-up polish that resolves the screenshot
TODOplaceholders introduced by #7443 inmodel_serving.md. No separate issue (small completion of #7443's own scope).Summary
endpoint_detail_ready_alert.pngandreplica_status_filter.pngfrom the live WebUI on a healthy deployment, in all 4 locales (en/ja/ko/th), at 2× zoom viawindow.switchLanguageperSCREENSHOT-GUIDELINES.md.<!-- TODO: Capture screenshot — ... -->comments insrc/{en,ja,ko,th}/model_serving/model_serving.md(8 lines total). Image references and surrounding blank lines unchanged.Intentionally left as-is
endpoint_detail_shm.pngTODO kept. The live Endpoint Detail Page has no "Service Info" card (it renders "Basic Information") and surfaces no Shared Memory (SHM) field for the available deployment (verified via DOM scan). Capturing it would require fabrication — and it signals a doc↔UI mismatch in docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish #7443's prose that should be addressed in docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish #7443, not faked here.TODO(Deployment Presets link) kept.deployment_presets.mdis added by docs(model-serving): add Deployment Preset management documentation #7444, which is stacked above docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish #7443; restoring the link here would create a broken internal link. Belongs in docs(model-serving): add Deployment Preset management documentation #7444's scope.Notes for #7443 author
Test plan
src/{en,ja,ko,th}/images/endpoint_detail_ready_alert.pngandreplica_status_filter.pngrender in the manual.model_serving.md.🤖 Generated with Claude Code