docs(FR-2086): convert legacy formatting to admonitions and add cross-reference anchors by yomybaby · Pull Request #5450 · lablup/backend.ai-webui

yomybaby · 2026-02-19T22:26:54Z

Resolves #5449 (FR-2086)

Summary

Convert 3-space indented notes to :::note/:::warning admonitions across EN, JA, TH docs (91 notes, 3 warnings)
Add ~100 HTML anchor tags (<a id="...">) for stable cross-reference targets in EN, JA, TH
Fix 7 broken cross-reference anchor links across all 4 languages (EN, KO, JA, TH):
- #open-app-to-public, #service-definition-file, #delete-customized-image (missing anchors)
- #admin-menus, #model-serving, #my-environments, #chat-page (missing in translated pages)
- #scheduling-methods (missing in JA/TH)
Fix 20+ cross-reference links from legacy <anchor> format to standard markdown anchors
Remove duplicate H1 headings and fix broken markup (e.g., stray backticks)
Convert indented code examples to proper fenced code blocks
Update /review-pr-feedback command to re-request review from CHANGES_REQUESTED reviewers after applying fixes

Note: This is a follow-up to #5404 which handled Korean docs. This PR covers the remaining EN, JA, TH documentation plus cross-language anchor fixes.

Test plan

Verify all 3-space indented notes are converted to admonitions in EN, JA, TH docs
Check HTML anchor tags are properly placed before their target headings
Confirm cross-reference links resolve correctly (38 previously broken links fixed)
Review PDF/HTML build output renders admonitions properly

🤖 Generated with Claude Code

yomybaby · 2026-02-19T22:27:14Z

docs(FR-2086): convert legacy formatting to admonitions and add cross-reference anchors #5450 👈 (View in Graphite)
docs(FR-2075): standardize admonition types and fix formatting across documentation #5404 : 1 other dependent PR (#5423 )
docs(FR-2074): improve PDF documentation layout and structure #5403
feat(FR-2084): extract docs-toolkit as reusable package #5397
main

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 hot fixes, skip the queue and merge this PR next

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.

Copilot

Pull request overview

This PR updates the Backend.AI WebUI user manual (packages/backend.ai-webui-docs/) to modernize formatting across EN/JA/TH by converting legacy indented notes into :::note/:::warning admonitions, adding stable HTML anchors for cross-references, and cleaning up legacy markup (RST remnants, broken headings, and code blocks).

Changes:

Convert legacy 3-space indented note/warning blocks into admonitions across EN/JA/TH docs.
Add <a id="..."></a> anchors to provide stable, English cross-reference targets in translated pages.
Normalize various legacy cross-reference formats and fix broken markup (including fenced code blocks and headings).

Reviewed changes

Copilot reviewed 75 out of 75 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	Convert legacy notes to admonitions; add anchors and update links.
packages/backend.ai-webui-docs/src/th/user_settings/user_settings.md	Add anchors and convert legacy notes to admonitions.
packages/backend.ai-webui-docs/src/th/trouble_shooting/trouble_shooting.md	Add anchors; convert indented code and notes to fenced blocks/admonitions.
packages/backend.ai-webui-docs/src/th/summary/summary.md	Convert deprecation notice and notes to admonitions; update links.
packages/backend.ai-webui-docs/src/th/start/start.md	Update shortcut links; convert note to admonition.
packages/backend.ai-webui-docs/src/th/share_vfolder/share_vfolder.md	Add anchors; convert legacy notes to admonitions; update links.
packages/backend.ai-webui-docs/src/th/sessions_all/sessions_all.md	Add many stable anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/th/session_page/session_page.md	Add anchors for sections.
packages/backend.ai-webui-docs/src/th/quickstart.md	Normalize quickstart cross-reference links to new anchors.
packages/backend.ai-webui-docs/src/th/overview/overview.md	Add anchors; restructure/normalize tables and notes.
packages/backend.ai-webui-docs/src/th/my_environments/my_environments.md	Update cross-reference to new anchor.
packages/backend.ai-webui-docs/src/th/mount_vfolder/mount_vfolder.md	Add anchors; convert legacy notes and code to admonitions/fenced blocks; normalize links.
packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md	Convert notes/warnings; add anchors; convert tables/code blocks; normalize links.
packages/backend.ai-webui-docs/src/th/login/login.md	Add anchors; convert legacy notes/warnings to admonitions.
packages/backend.ai-webui-docs/src/th/license_agreement/license_agreement.md	Normalize numbered list formatting.
packages/backend.ai-webui-docs/src/th/installation/installation.md	Convert legacy indented notes to admonitions.
packages/backend.ai-webui-docs/src/th/import_run/import_run.md	Add anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/th/header/header.md	Add anchors; convert note to admonition.
packages/backend.ai-webui-docs/src/th/disclaimer.md	Clean up legacy table-like markup into plain text.
packages/backend.ai-webui-docs/src/th/cluster_session/cluster_session.md	Convert legacy note to admonition; add anchors.
packages/backend.ai-webui-docs/src/th/chat/chat.md	Add anchors; normalize cross-reference link.
packages/backend.ai-webui-docs/src/th/appendix/appendix.md	Add anchors; convert legacy note/code formatting; normalize links.
packages/backend.ai-webui-docs/src/th/agent_summary/agent_summary.md	Convert legacy note to admonition.
packages/backend.ai-webui-docs/src/ja/vfolder/vfolder.md	Convert legacy notes to admonitions; add anchors and update links.
packages/backend.ai-webui-docs/src/ja/user_settings/user_settings.md	Add anchors and convert legacy notes to admonitions.
packages/backend.ai-webui-docs/src/ja/trouble_shooting/trouble_shooting.md	Add anchors; convert indented code and notes to fenced blocks/admonitions.
packages/backend.ai-webui-docs/src/ja/summary/summary.md	Convert deprecation notice and notes to admonitions; update links.
packages/backend.ai-webui-docs/src/ja/start/start.md	Update shortcut links; convert note to admonition.
packages/backend.ai-webui-docs/src/ja/share_vfolder/share_vfolder.md	Add anchors; convert legacy notes to admonitions; update links.
packages/backend.ai-webui-docs/src/ja/sessions_all/sessions_all.md	Add many stable anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/ja/session_page/session_page.md	Add anchors for sections.
packages/backend.ai-webui-docs/src/ja/quickstart.md	Normalize quickstart cross-reference links to new anchors.
packages/backend.ai-webui-docs/src/ja/overview/overview.md	Add anchors; restructure/normalize tables and notes.
packages/backend.ai-webui-docs/src/ja/my_environments/my_environments.md	Update cross-reference to new anchor.
packages/backend.ai-webui-docs/src/ja/mount_vfolder/mount_vfolder.md	Add anchors; convert legacy notes and code to admonitions/fenced blocks; normalize links.
packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md	Convert notes/warnings; add anchors; convert tables/code blocks; normalize links.
packages/backend.ai-webui-docs/src/ja/login/login.md	Add anchors; convert legacy notes/warnings to admonitions.
packages/backend.ai-webui-docs/src/ja/license_agreement/license_agreement.md	Normalize numbered list formatting.
packages/backend.ai-webui-docs/src/ja/installation/installation.md	Convert legacy indented notes to admonitions.
packages/backend.ai-webui-docs/src/ja/import_run/import_run.md	Add anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/ja/header/header.md	Add anchors; convert note to admonition.
packages/backend.ai-webui-docs/src/ja/disclaimer.md	Clean up legacy table-like markup into plain text.
packages/backend.ai-webui-docs/src/ja/cluster_session/cluster_session.md	Convert legacy note to admonition; add anchors.
packages/backend.ai-webui-docs/src/ja/chat/chat.md	Add anchors; normalize cross-reference link.
packages/backend.ai-webui-docs/src/ja/appendix/appendix.md	Add anchors; convert legacy note/code formatting; normalize links.
packages/backend.ai-webui-docs/src/ja/agent_summary/agent_summary.md	Convert legacy note to admonition.
packages/backend.ai-webui-docs/src/en/vfolder/vfolder.md	Convert legacy notes to admonitions; add anchors and update links.
packages/backend.ai-webui-docs/src/en/user_settings/user_settings.md	Add anchors and convert legacy notes to admonitions.
packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md	Add anchors; convert indented code and notes to fenced blocks/admonitions.
packages/backend.ai-webui-docs/src/en/summary/summary.md	Convert deprecation notice and notes to admonitions; update links.
packages/backend.ai-webui-docs/src/en/start/start.md	Update shortcut links; convert note to admonition.
packages/backend.ai-webui-docs/src/en/share_vfolder/share_vfolder.md	Add anchors; convert legacy notes to admonitions; update links.
packages/backend.ai-webui-docs/src/en/sessions_all/sessions_all.md	Add many stable anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/en/session_page/session_page.md	Add anchors for sections.
packages/backend.ai-webui-docs/src/en/quickstart.md	Normalize quickstart cross-reference links to new anchors.
packages/backend.ai-webui-docs/src/en/overview/overview.md	Add anchors; update headings/notes and normalize cross-reference section.
packages/backend.ai-webui-docs/src/en/my_environments/my_environments.md	Update cross-reference to new anchor.
packages/backend.ai-webui-docs/src/en/mount_vfolder/mount_vfolder.md	Add anchors; convert legacy notes and code to admonitions/fenced blocks; normalize links.
packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md	Convert notes/warnings; add anchors; convert tables/code blocks; normalize links.
packages/backend.ai-webui-docs/src/en/login/login.md	Add anchors; convert legacy notes/warnings to admonitions.
packages/backend.ai-webui-docs/src/en/license_agreement/license_agreement.md	Normalize numbered list formatting.
packages/backend.ai-webui-docs/src/en/installation/installation.md	Convert legacy indented notes to admonitions.
packages/backend.ai-webui-docs/src/en/import_run/import_run.md	Add anchors; convert legacy notes to admonitions; normalize links.
packages/backend.ai-webui-docs/src/en/header/header.md	Add anchors; convert note to admonition.
packages/backend.ai-webui-docs/src/en/disclaimer.md	Clean up legacy table-like markup into plain text.
packages/backend.ai-webui-docs/src/en/cluster_session/cluster_session.md	Convert legacy note to admonition; add anchors.
packages/backend.ai-webui-docs/src/en/chat/chat.md	Add anchors; normalize cross-reference link.
packages/backend.ai-webui-docs/src/en/appendix/appendix.md	Add anchors; convert legacy note/code formatting; normalize links.
packages/backend.ai-webui-docs/src/en/agent_summary/agent_summary.md	Convert legacy note to admonition.

packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md

packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md

packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md

packages/backend.ai-webui-docs/src/ja/overview/overview.md

packages/backend.ai-webui-docs/src/th/overview/overview.md

ironAiken2

Some anchor links are not working. Please also review the copilot.

yomybaby · 2026-02-20T09:46:52Z

Fixed broken anchor links in the latest push. Added missing <a id> anchors across 16 files:

Missing anchors (all 4 languages):

#open-app-to-public → added in sessions_all.md
#service-definition-file → added in model_serving.md
#delete-customized-image → added in my_environments.md

Missing anchors in translated pages (ko/ja/th):

#admin-menus → added before H1 in admin_menu.md
#model-serving → added before H1 in model_serving.md
#my-environments → added before H1 in my_environments.md
#scheduling-methods → added in admin_menu.md (ja/th)
#chat-page → added before H1 in chat.md (ko)

Also reviewed the 5 Copilot comments — all were false positives (tables use | | for empty cells, not ||). Replied and resolved.

ironAiken2

LGTM

graphite-app · 2026-02-20T10:04:37Z

Merge activity

Feb 20, 10:04 AM UTC: yomybaby added this pull request to the Graphite merge queue.
Feb 20, 10:06 AM UTC: Merged by the Graphite merge queue.

…-reference anchors (#5450) Resolves #5449 ([FR-2086](https://lablup.atlassian.net/browse/FR-2086)) ## Summary - Convert 3-space indented notes to `:::note`/`:::warning` admonitions across EN, JA, TH docs (91 notes, 3 warnings) - Add ~100 HTML anchor tags (`<a id="...">`) for stable cross-reference targets in EN, JA, TH - Fix 7 broken cross-reference anchor links across all 4 languages (EN, KO, JA, TH): - `#open-app-to-public`, `#service-definition-file`, `#delete-customized-image` (missing anchors) - `#admin-menus`, `#model-serving`, `#my-environments`, `#chat-page` (missing in translated pages) - `#scheduling-methods` (missing in JA/TH) - Fix 20+ cross-reference links from legacy `<anchor>` format to standard markdown anchors - Remove duplicate H1 headings and fix broken markup (e.g., stray backticks) - Convert indented code examples to proper fenced code blocks - Update `/review-pr-feedback` command to re-request review from CHANGES_REQUESTED reviewers after applying fixes > **Note**: This is a follow-up to #5404 which handled Korean docs. This PR covers the remaining EN, JA, TH documentation plus cross-language anchor fixes. ## Test plan - [x] Verify all 3-space indented notes are converted to admonitions in EN, JA, TH docs - [x] Check HTML anchor tags are properly placed before their target headings - [x] Confirm cross-reference links resolve correctly (38 previously broken links fixed) - [ ] Review PDF/HTML build output renders admonitions properly 🤖 Generated with [Claude Code](https://claude.com/claude-code) [FR-2086]: https://lablup.atlassian.net/browse/FR-2086?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

github-actions bot assigned yomybaby Feb 19, 2026

github-actions bot added the size:XL 500~ LoC label Feb 19, 2026

This was referenced Feb 19, 2026

docs(FR-2075): standardize admonition types and fix formatting across documentation #5404

Merged

feat(FR-2084): extract docs-toolkit as reusable package #5397

Merged

docs(FR-2074): improve PDF documentation layout and structure #5403

Merged

yomybaby mentioned this pull request Feb 19, 2026

chore(FR-2085): configure backend.ai-docs-toolkit package for npm registry publishing #5423

Merged

5 tasks

yomybaby marked this pull request as ready for review February 20, 2026 02:34

Copilot AI review requested due to automatic review settings February 20, 2026 02:34

Copilot started reviewing on behalf of yomybaby February 20, 2026 02:34 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

ironAiken2 requested changes Feb 20, 2026

View reviewed changes

yomybaby force-pushed the 02-20-docs_fr-2086_convert_legacy_formatting_to_admonitions_and_add_cross-reference_anchors branch from 6b7a7d2 to e3b5d43 Compare February 20, 2026 09:46

yomybaby force-pushed the 02-19-docs_fr-2075_standardize_admonition_types_and_fix_formatting_across_documentation branch from 3edff16 to 40e0a46 Compare February 20, 2026 09:46

yomybaby requested a review from ironAiken2 February 20, 2026 09:51

ironAiken2 approved these changes Feb 20, 2026

View reviewed changes

graphite-app bot changed the base branch from 02-19-docs_fr-2075_standardize_admonition_types_and_fix_formatting_across_documentation to graphite-base/5450 February 20, 2026 09:55

yomybaby force-pushed the 02-20-docs_fr-2086_convert_legacy_formatting_to_admonitions_and_add_cross-reference_anchors branch from e3b5d43 to 97cb2d3 Compare February 20, 2026 10:02

yomybaby force-pushed the graphite-base/5450 branch from 40e0a46 to 4c2bde4 Compare February 20, 2026 10:02

yomybaby changed the base branch from graphite-base/5450 to main February 20, 2026 10:02

graphite-app bot force-pushed the 02-20-docs_fr-2086_convert_legacy_formatting_to_admonitions_and_add_cross-reference_anchors branch from 97cb2d3 to 6d7e966 Compare February 20, 2026 10:05

graphite-app bot merged commit 6d7e966 into main Feb 20, 2026
7 checks passed

graphite-app bot deleted the 02-20-docs_fr-2086_convert_legacy_formatting_to_admonitions_and_add_cross-reference_anchors branch February 20, 2026 10:06

github-pages bot temporarily deployed to github-pages February 20, 2026 10:06 Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

docs(FR-2086): convert legacy formatting to admonitions and add cross-reference anchors#5450

docs(FR-2086): convert legacy formatting to admonitions and add cross-reference anchors#5450
graphite-app[bot] merged 1 commit intomainfrom
02-20-docs_fr-2086_convert_legacy_formatting_to_admonitions_and_add_cross-reference_anchors

yomybaby commented Feb 19, 2026 •

edited

Loading

Uh oh!

yomybaby commented Feb 19, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ironAiken2 left a comment

Uh oh!

yomybaby commented Feb 20, 2026

Uh oh!

ironAiken2 left a comment

Uh oh!

graphite-app bot commented Feb 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

yomybaby commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

yomybaby commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ironAiken2 left a comment

Choose a reason for hiding this comment

Uh oh!

yomybaby commented Feb 20, 2026

Uh oh!

ironAiken2 left a comment

Choose a reason for hiding this comment

Uh oh!

graphite-app bot commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yomybaby commented Feb 19, 2026 •

edited

Loading

yomybaby commented Feb 19, 2026 •

edited

Loading

graphite-app bot commented Feb 20, 2026 •

edited

Loading