Skip to content

docs(FR-2571): address PR #6631 review feedback (excl. model store)#6708

Merged
graphite-app[bot] merged 1 commit intomainfrom
04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_
Apr 22, 2026
Merged

docs(FR-2571): address PR #6631 review feedback (excl. model store)#6708
graphite-app[bot] merged 1 commit intomainfrom
04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_

Conversation

@nowgnuesLee
Copy link
Copy Markdown
Contributor

@nowgnuesLee nowgnuesLee commented Apr 15, 2026

Resolves #6675 follow-up — Addresses review feedback on PR #6631 (model-store items intentionally excluded).

Stacked on top of PR #6631 (04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation).

Changes

Text edits (applied identically across en/ko/ja/th)

  • header/header.md: Replaced "when the server supports the V2 user update API" phrasing in both the Allowed Client IPs note and the Original password note with explicit version gating — "Backend.AI 26.4.0 and later".
  • vfolder/vfolder.md §10.1: Clarified that for project folders, the project currently selected in the top bar is automatically selected as the target. (Model-type project-folder sentence intentionally excluded.)
  • vfolder/vfolder.md write_content: Rewrote the File Edit button permission description — it is a per-folder (vfolder) RBAC permission granted via folder sharing or role, not a storage-host setting. Verified against react/src/components/FolderExplorerModal.tsx (reads vfolder_node.permissions).
  • vfolder/vfolder.md §10.3: Folder rename is now described as available only inside the folder detail drawer (removed "from the Controls column").
  • vfolder/vfolder.md §10.7: Removed the empty Folder Categories H2 heading.
  • overview/overview.md §3.3: Added a Project row to the "Accessible Menu by User Role" table.

Screenshots recaptured (captured in English UI, copied to all 4 language images/ dirs)

  • header.png — top bar including visible Login Session Timer (Fig 6.1)
  • menu_collapse.png — sidebar without customer-specific plugin entries (Fig 7.2)
  • data_page.png — folder list with Controls column merged into Name (Fig 10.1 / §10.4)
  • vfolder_create_modal.png — current folder-creation modal
  • rename_vfolder.png — rename UI inside the detail drawer
  • move_to_trash.png — new Modal confirmation (replaces Popconfirm)
  • vfolder_delete_dialog.png — current Delete Forever modal
  • sessions_page.png — current Sessions page layout (Fig 11.1)
  • launch_session_resource_2.png — Cluster Mode launcher step
  • launch_session_data.png — Data & Storage launcher step

Explicitly excluded (per request)

  • All model-store-related items:
    • "Model-type project folders can only be created within projects designated as model store projects" (§10.1 item Add UI backbone frame #2)
    • "Run directly using the deploy button" (model store §26.4.0 content)

Deferred (out of scope)

  • Per-language localized screenshot policy (reviewer request conflicts with current SCREENSHOT-GUIDELINES.md — recommended to change policy in a follow-up PR).
  • Pre-existing untranslated English blocks in ja/ and th/ sessions_all.md and vfolder.md §10.1 bullets — flagged by reviewer, not touched in this PR.

Agent workflow

Generated via fw:docs-plannerfw:docs-writer → screenshots captured via Chrome DevTools MCP → docs-update-reviewer cross-language + cross-page link review (MINOR FIXES APPLIED). Agent artifacts: .agent-output/docs-update-plan-pr6631-review.md, .agent-output/docs-review-report-pr6708-cross-lang-and-links.md.

Reviewer auto-fixes:

  • Corrected broken image reference launce_session_resource_2.pnglaunch_session_resource_2.png in all 4 sessions_all.md (pre-existing typo, made load-bearing by this PR recapturing the file).
  • Collapsed stray double blank line before :::note block after Cluster mode bullet.

Checklist:

  • Documentation
  • Structural parity across en/ko/ja/th verified
  • Cross-page links and image references verified
  • No model-store content introduced

@github-actions github-actions Bot added the size:L 100~500 LoC label Apr 15, 2026
Copy link
Copy Markdown
Contributor Author

nowgnuesLee commented Apr 15, 2026


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • flow:merge-queue - adds this PR to the back of the merge queue
  • flow:hotfix - for urgent changes, fast-track this PR to the front of 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 nowgnuesLee force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from b6ad1d2 to ed5cf91 Compare April 15, 2026 07:38
@nowgnuesLee nowgnuesLee force-pushed the 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation branch from 4ced479 to 7145c0e Compare April 15, 2026 07:38
@github-actions github-actions Bot added size:M 30~100 LoC and removed size:L 100~500 LoC labels Apr 15, 2026
@nowgnuesLee nowgnuesLee force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch 2 times, most recently from ff724b9 to 905f401 Compare April 15, 2026 08:02
@nowgnuesLee nowgnuesLee marked this pull request as ready for review April 15, 2026 08:22
Copilot AI review requested due to automatic review settings April 15, 2026 08:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Backend.AI WebUI user manual (EN/JA/KO/TH) to incorporate review feedback around vfolder UX, session launcher screenshots, role-based menu tables, and user account field availability (excluding model store-related updates).

Changes:

  • Clarify vfolder behavior (project auto-selection, edit-file permission semantics, rename flow) and remove the “Folder Categories” heading across languages.
  • Fix the session launcher screenshot filename reference (launce_…launch_…) across languages.
  • Update “My Account” field availability notes to be version-based (Backend.AI 26.4.0) and add “Project*” to the accessible-menu tables; add missing move_to_trash.png assets.

Reviewed changes

Copilot reviewed 16 out of 56 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
packages/backend.ai-webui-docs/src/th/vfolder/vfolder.md Updates Thai vfolder docs (project auto-select, edit-file permission, rename flow, removes “Folder Categories”).
packages/backend.ai-webui-docs/src/th/sessions_all/sessions_all.md Fixes Thai session launcher screenshot filename reference.
packages/backend.ai-webui-docs/src/th/overview/overview.md Adds “Project*” row to Thai accessible-menu table.
packages/backend.ai-webui-docs/src/th/images/move_to_trash.png Adds Thai “move to trash” screenshot asset.
packages/backend.ai-webui-docs/src/th/header/header.md Updates Thai “My Account” field availability notes to Backend.AI 26.4.0-based wording.
packages/backend.ai-webui-docs/src/ko/vfolder/vfolder.md Updates Korean vfolder docs (project auto-select, edit-file permission, rename flow, removes “Folder Categories”).
packages/backend.ai-webui-docs/src/ko/sessions_all/sessions_all.md Fixes Korean session launcher screenshot filename reference.
packages/backend.ai-webui-docs/src/ko/overview/overview.md Adds “Project*” row to Korean accessible-menu table.
packages/backend.ai-webui-docs/src/ko/images/move_to_trash.png Adds Korean “move to trash” screenshot asset.
packages/backend.ai-webui-docs/src/ko/header/header.md Updates Korean “My Account” field availability notes to Backend.AI 26.4.0-based wording.
packages/backend.ai-webui-docs/src/ja/vfolder/vfolder.md Updates Japanese vfolder docs (project auto-select, edit-file permission, rename flow, removes “Folder Categories”).
packages/backend.ai-webui-docs/src/ja/sessions_all/sessions_all.md Fixes Japanese session launcher screenshot filename reference.
packages/backend.ai-webui-docs/src/ja/overview/overview.md Adds “Project*” row to Japanese accessible-menu table.
packages/backend.ai-webui-docs/src/ja/images/move_to_trash.png Adds Japanese “move to trash” screenshot asset.
packages/backend.ai-webui-docs/src/ja/header/header.md Updates Japanese “My Account” field availability notes to Backend.AI 26.4.0-based wording.
packages/backend.ai-webui-docs/src/en/vfolder/vfolder.md Updates English vfolder docs (project auto-select, edit-file permission semantics, rename flow, removes “Folder Categories”).
packages/backend.ai-webui-docs/src/en/sessions_all/sessions_all.md Fixes English session launcher screenshot filename reference.
packages/backend.ai-webui-docs/src/en/overview/overview.md Adds “Project*” row to English accessible-menu table.
packages/backend.ai-webui-docs/src/en/images/move_to_trash.png Adds English “move to trash” screenshot asset.
packages/backend.ai-webui-docs/src/en/header/header.md Updates English “My Account” field availability notes to Backend.AI 26.4.0-based wording.

Comment thread packages/backend.ai-webui-docs/src/ja/sessions_all/sessions_all.md
Comment thread packages/backend.ai-webui-docs/src/th/sessions_all/sessions_all.md
Comment thread packages/backend.ai-webui-docs/src/th/vfolder/vfolder.md Outdated
Comment thread packages/backend.ai-webui-docs/src/en/sessions_all/sessions_all.md
Comment thread packages/backend.ai-webui-docs/src/ko/sessions_all/sessions_all.md
@nowgnuesLee nowgnuesLee force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from 905f401 to 84383b8 Compare April 15, 2026 09:19
@github-actions github-actions Bot removed the size:M 30~100 LoC label Apr 15, 2026
@nowgnuesLee nowgnuesLee force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch 3 times, most recently from 4ed4a50 to eca7dc0 Compare April 16, 2026 09:36
@nowgnuesLee nowgnuesLee force-pushed the 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation branch from 197a31a to eb33dc6 Compare April 16, 2026 09:36
@agatha197 agatha197 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from eca7dc0 to f02fa57 Compare April 16, 2026 14:47
@agatha197 agatha197 force-pushed the 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation branch from eb33dc6 to a630b56 Compare April 16, 2026 14:47
@yomybaby yomybaby changed the base branch from 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation to graphite-base/6708 April 17, 2026 11:12
@agatha197 agatha197 force-pushed the graphite-base/6708 branch from a630b56 to 10116bf Compare April 21, 2026 10:23
@agatha197 agatha197 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from f02fa57 to 0878891 Compare April 21, 2026 10:23
@agatha197 agatha197 changed the base branch from graphite-base/6708 to 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation April 21, 2026 10:24
@graphite-app graphite-app Bot changed the base branch from 04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation to graphite-base/6708 April 22, 2026 02:00
@ironAiken2 ironAiken2 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from 0878891 to 6a6fc73 Compare April 22, 2026 03:31
@ironAiken2 ironAiken2 changed the base branch from graphite-base/6708 to main April 22, 2026 03:31
@graphite-app
Copy link
Copy Markdown

graphite-app Bot commented Apr 22, 2026

Merge activity

…6708)

Resolves #6675 follow-up — Addresses review feedback on PR #6631 (model-store items intentionally excluded).

Stacked on top of PR #6631 (`04-13-docs_header_add_allowed_client_ips_field_to_my_account_dialog_documentation`).

## Changes

### Text edits (applied identically across en/ko/ja/th)
- **header/header.md**: Replaced "when the server supports the V2 user update API" phrasing in both the **Allowed Client IPs** note and the **Original password** note with explicit version gating — *"Backend.AI 26.4.0 and later"*.
- **vfolder/vfolder.md §10.1**: Clarified that for project folders, the project currently selected in the top bar is automatically selected as the target. (Model-type project-folder sentence intentionally **excluded**.)
- **vfolder/vfolder.md `write_content`**: Rewrote the File Edit button permission description — it is a per-folder (vfolder) RBAC permission granted via folder sharing or role, **not** a storage-host setting. Verified against `react/src/components/FolderExplorerModal.tsx` (reads `vfolder_node.permissions`).
- **vfolder/vfolder.md §10.3**: Folder rename is now described as available only inside the folder detail drawer (removed "from the Controls column").
- **vfolder/vfolder.md §10.7**: Removed the empty *Folder Categories* H2 heading.
- **overview/overview.md §3.3**: Added a **Project** row to the "Accessible Menu by User Role" table.

### Screenshots recaptured (captured in English UI, copied to all 4 language `images/` dirs)
- `header.png` — top bar **including visible Login Session Timer** (Fig 6.1)
- `menu_collapse.png` — sidebar without customer-specific plugin entries (Fig 7.2)
- `data_page.png` — folder list with **Controls column merged into Name** (Fig 10.1 / §10.4)
- `vfolder_create_modal.png` — current folder-creation modal
- `rename_vfolder.png` — rename UI **inside the detail drawer**
- `move_to_trash.png` — new **Modal** confirmation (replaces Popconfirm)
- `vfolder_delete_dialog.png` — current Delete Forever modal
- `sessions_page.png` — current Sessions page layout (Fig 11.1)
- `launch_session_resource_2.png` — Cluster Mode launcher step
- `launch_session_data.png` — Data & Storage launcher step

### Explicitly excluded (per request)
- All model-store-related items:
  - *"Model-type project folders can only be created within projects designated as model store projects"* (§10.1 item #2)
  - *"Run directly using the `deploy` button"* (model store §26.4.0 content)

### Deferred (out of scope)
- Per-language localized screenshot policy (reviewer request conflicts with current `SCREENSHOT-GUIDELINES.md` — recommended to change policy in a follow-up PR).
- Pre-existing untranslated English blocks in `ja/` and `th/` `sessions_all.md` and `vfolder.md` §10.1 bullets — flagged by reviewer, not touched in this PR.

## Agent workflow

Generated via `fw:docs-planner` → `fw:docs-writer` → screenshots captured via Chrome DevTools MCP → `docs-update-reviewer` cross-language + cross-page link review (MINOR FIXES APPLIED). Agent artifacts: `.agent-output/docs-update-plan-pr6631-review.md`, `.agent-output/docs-review-report-pr6708-cross-lang-and-links.md`.

Reviewer auto-fixes:
- Corrected broken image reference `launce_session_resource_2.png` → `launch_session_resource_2.png` in all 4 `sessions_all.md` (pre-existing typo, made load-bearing by this PR recapturing the file).
- Collapsed stray double blank line before `:::note` block after Cluster mode bullet.

**Checklist:**
- [x] Documentation
- [x] Structural parity across en/ko/ja/th verified
- [x] Cross-page links and image references verified
- [x] No model-store content introduced
@graphite-app graphite-app Bot force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from 6a6fc73 to 5a3e5d8 Compare April 22, 2026 03:34
graphite-app Bot pushed a commit that referenced this pull request Apr 22, 2026
…4.0+) (#6760)

Stacked on top of PR #6708 (the `excl. model store` PR). Completes the FR-2571 docs work by documenting the Model Store V2 and Auto Scaling Rules V2 surfaces that were intentionally deferred from #6708.

## Structural approach

Decided with the user: document **both legacy and V2 paths side-by-side, split by explicit Backend.AI manager version**. Legacy prose stays in place as-is; V2 is appended as a versioned `####` subsection with a `:::note` admonition pointing from the legacy block to the new block. No `<details>` collapsibles — both variants are equally visible.

The structural pattern used in every affected section:

```markdown
### Section Heading

<legacy prose — kept, with legacy screenshot>

:::note
From Backend.AI version 26.4.0 onwards, this section has been redesigned. If
you are on an older version, the description above still applies. Otherwise,
refer to [Section (version 26.4.0 and later)](#section-version-26-4-0-and-later) below.
:::

<a id="section-version-26-4-0-and-later"></a>

#### Section (version 26.4.0 and later)

<V2 prose with new V2 screenshot>
```

## Version resolution

**Backend.AI manager 26.4.0** is the cutover version for both V2 surfaces. Verified at:

- `src/lib/backend.ai-client-esm.ts:895–904` — `model-card-v2` (line 901) and `prometheus-auto-scaling-rule` (line 903) are both gated on `isManagerVersionCompatibleWith('26.4.0')`.
- `.specs/draft-auto-scaling-rule-ux/spec.md:48` — auto-scaling spec explicitly states `>=26.4.0`.
- `.specs/model-store-v2-migration/dev-plan.md:13-25` — same manager version for model-store V2.

## Changes (applied identically across en / ko / ja / th)

### `model_serving.md` — three V2 subsections appended

1. **`### Auto Scaling Rules` → `#### Auto Scaling Rules (version 26.4.0 and later)`**: new Prometheus metric source with preset + live preview, Single/Range condition segmented control with directional threshold, Time Window (replaces legacy CoolDown Seconds), Step Size as positive integer with contextual sign prefix, separate Min/Max Replicas fields, property filters + pagination + Last Triggered column, inline Edit/Delete on Condition cell.
2. **`## Model Store` → `### Model Store (version 26.4.0 and later)`**: search+sort layout (replaces Category/Task/Label dropdowns), card detail Drawer (replaces Modal), card 50%-opacity + Deploy-disabled state for zero-preset models, two-scenario Deploy flow (auto-deploy vs Deploy Model selection modal), explicit absence of Clone button with cross-page link to `../vfolder/vfolder.md`.
3. **`### Admin Model Store Management` → `#### Admin Model Store Management (version 26.4.0 and later)`**: new column set (Name / Title / Category / Task / Access Level / Domain / Project / Created At — no Labels, no separate Controls column), `Private` / `Public` access tags, name-only property filter, inline Edit/Delete on Name cell via `BAINameActionCell`, row-selection bulk delete, explicit note that `Scan Project Model Cards` button is not available in 26.4.0+.

### Ripple edits (3 sites augmented, not replaced)

- `### Guide to Steps for Using Model Service` `:::tip` block
- `### Creating a Service Definition File` (two references)

Pattern: ``Run this model`` button (``Deploy`` on version 26.4.0 and later).

### 7 new V2 screenshots

Captured in English UI, copied byte-identically to all 4 language `images/` dirs (MD5 verified).

- `auto_scaling_rules_v2.png`
- `auto_scaling_rules_modal_v2.png` (Kernel + Single)
- `auto_scaling_rules_modal_prometheus_v2.png` (Prometheus preset + Range)
- `model_store_page_v2.png`
- `model_card_detail_drawer.png`
- `model_card_deploy_modal.png`
- `admin_model_card_list_v2.png`

Existing legacy screenshots (`auto_scaling_rules.png`, `auto_scaling_rules_modal.png`, `model_store_page.png`, `model_card_detail_modal.png`, `model_clone_dialog.png`, `admin_model_card_list.png`) are untouched and continue to document the legacy variants.

### Bug fix

Broken cross-reference `[Data](#data)` → `[Data](../vfolder/vfolder.md)` (relative cross-page link per project convention).

## Structural parity verification

- 43 headings per file, identical `#`-level sequences across en/ko/ja/th.
- 3 English-only anchors (`auto-scaling-rules-version-26-4-0-and-later`, `model-store-version-26-4-0-and-later`, `admin-model-store-management-version-26-4-0-and-later`) present in all four files.
- All 7 V2 image references identical across languages.
- Legacy prose intact — only diffs outside the new V2 blocks are the 3 ripple-site rewrites.
- `book.config.yaml` unchanged (no new top-level pages introduced).

## Agent workflow

Planned via `docs-update-planner` → written via `docs-update-writer` → quality reviewed via `docs-update-reviewer` (18 auto-fixes applied: PUBLIC → Public tag casing, 3-space indented notes → `:::note` admonitions, `Backend.AI version 26.4.0` prefix consistency) → screenshots via `docs-screenshot-capturer`.

Artifacts (in `.agent-output/`, gitignored):
- `docs-update-plan-model-store-and-autoscaling.md`
- `docs-review-report-model-store-and-autoscaling.md`

**Checklist:**
- [x] Documentation
- [x] Structural parity across en/ko/ja/th verified
- [x] Version number resolved (26.4.0) and referenced consistently
- [x] Cross-page links and image references verified
- [x] Legacy prose preserved; V2 subsections appended via `:::note` + anchor pattern
- [x] No `TODO(needs-version)` markers remain

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@graphite-app graphite-app Bot merged commit 5a3e5d8 into main Apr 22, 2026
8 checks passed
@graphite-app graphite-app Bot deleted the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch April 22, 2026 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L 100~500 LoC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add Allowed Client IPs field to My Account dialog documentation (FR-2571)

2 participants