docs(FR-2543): update model serving documentation with new features#6611
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Model Serving user manual across EN/KO/JA/TH to reflect recent WebUI features and the updated page/launcher UI, plus translation and structure improvements.
Changes:
- Added new documentation sections for Serving page overview, service launcher modes (including Enter Command mode), runtime parameters, endpoint detail workflows, Model Store, and admin management.
- Restructured legacy (<=23.03) guidance into collapsible
<details>blocks and normalized heading levels. - Filled previously untranslated/legacy English content in JA/TH and added TODO markers for missing screenshots.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md | Adds/updates major sections for Serving/launcher, endpoint detail operations, Model Store, and admin model card management. |
| packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md | Korean translation + new sections matching the updated EN structure and feature set. |
| packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md | Japanese translation + new sections matching the updated EN structure and feature set. |
| packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md | Thai translation + new sections matching the updated EN structure and feature set, with added TODO screenshot markers. |
42d5526 to
84e14ed
Compare
Coverage report for
|
St.❔ |
Category | Percentage | Covered / Total |
|---|---|---|---|
| 🟢 | Statements | 81.87% | 429/524 |
| 🟡 | Branches | 70.43% | 362/514 |
| 🟡 | Functions | 76.86% | 93/121 |
| 🟢 | Lines | 83.19% | 391/470 |
Test suite run success
319 tests passing in 13 suites.
Report generated by 🧪jest coverage report action from 84e14ed
Coverage report for
|
St.❔ |
Category | Percentage | Covered / Total |
|---|---|---|---|
| 🔴 | Statements | 8.95% (-0.12% 🔻) |
1750/19543 |
| 🔴 | Branches | 8.07% (-0.11% 🔻) |
1100/13636 |
| 🔴 | Functions | 5.41% (-0.09% 🔻) |
288/5325 |
| 🔴 | Lines | 8.64% (-0.11% 🔻) |
1641/18986 |
Show new covered files 🐣
St.❔ |
File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|---|
| 🔴 | ... / AuthorIcon.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / LegacyModelCardModal.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / LegacyModelTryContentButton.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / ModelCardDeployModal.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / ModelCardDrawer.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / useActiveErrorBoundary.ts |
0% | 100% | 0% | 0% |
| 🔴 | ... / useModelStoreProject.ts |
0% | 0% | 0% | 0% |
| 🔴 | ... / LegacyModelStoreListPage.tsx |
0% | 0% | 0% | 0% |
| 🔴 | ... / ModelStoreListPageV2.tsx |
0% | 0% | 0% | 0% |
Test suite run success
854 tests passing in 39 suites.
Report generated by 🧪jest coverage report action from 84e14ed
84e14ed to
02b4cdc
Compare
e08caf3 to
db94d35
Compare
02b4cdc to
92fca82
Compare
f42c4f1 to
ad19769
Compare
bb6c856 to
e6fe622
Compare
ec883b8 to
94869e6
Compare
Status update for @agatha197All 6 review threads on this PR are now resolved:
Since the scope of this PR is pre-26.4 model serving docs, and the 26.4.0 deploy-flow content is deliberately deferred to the follow-up stack per your earlier reference, could you re-review this PR so the |
Merge activity
|
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
ironAiken2
left a comment
There was a problem hiding this comment.
Please resolve the conflicts.
…ix Thai menu label - Add <a id="model-store"></a> before 모델 스토어 / モデルストア / Model Store headings in KO, JA, TH so cross-reference links resolve correctly - Fix Thai sidebar menu label: **Model Serving** → **การให้บริการ** (webui.menu.Serving) Resolves Copilot review comments on PR #6611 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
94869e6 to
0fd1c06
Compare
|
Conflicts have been resolved via |
…6611) Resolves #6687 (FR-2543) ## Summary - Rewrite and expand the Model Serving documentation with comprehensive coverage of new features - Document the **Model Store** tab for browsing, filtering, and importing pre-configured models - Document the **Inference Runtime Variant** options (vLLM, NVIDIA NIM, Hugging Face TGI, SGLang, etc.) with runtime-specific parameter tabs - Document the **Custom (Default)** runtime mode with **Enter Command** and **Use Config File** sub-modes - Document the **Replicas & Resources** section and **Advanced Settings** - Document **admin-only** features: Model Store Management tab, model card creation/editing, and the "Create Service from Model" workflow - Add screenshots for all new sections (English UI) across all 4 languages ## Changes - `model_serving/model_serving.md` (en/ko/ja/th): full rewrite with new sections - `*/images/`: 11 new/updated screenshots (service_launcher1, service_launcher_runtime_variant, service_launcher_command_mode, service_launcher2, service_launcher_runtime_params, service_launcher3, serving_list_page, model_store_page, admin_serving_page, admin_model_card_list, admin_model_card_modal, model_card_detail_modal, model_clone_dialog) ## Test plan - [ ] Verify Inference Runtime Variant dropdown options match the current UI - [ ] Verify Enter Command / Use Config File mode descriptions are accurate - [ ] Verify admin Model Store Management tab content is accurate - [ ] Verify all screenshots show English UI labels 🤖 Generated with [Claude Code](https://claude.com/claude-code)
0fd1c06 to
8c9ee03
Compare

Resolves #6687 (FR-2543)
Summary
Changes
model_serving/model_serving.md(en/ko/ja/th): full rewrite with new sections*/images/: 11 new/updated screenshots (service_launcher1, service_launcher_runtime_variant, service_launcher_command_mode, service_launcher2, service_launcher_runtime_params, service_launcher3, serving_list_page, model_store_page, admin_serving_page, admin_model_card_list, admin_model_card_modal, model_card_detail_modal, model_clone_dialog)Test plan
🤖 Generated with Claude Code