Skip to content

docs: rewrite WebUI user guide for accuracy and bilingual parity#462

Merged
xlabtg merged 4 commits intoxlabtg:mainfrom
konard:issue-461-76d56611c0e7
Apr 28, 2026
Merged

docs: rewrite WebUI user guide for accuracy and bilingual parity#462
xlabtg merged 4 commits intoxlabtg:mainfrom
konard:issue-461-76d56611c0e7

Conversation

@konard
Copy link
Copy Markdown

@konard konard commented Apr 28, 2026

Fixes #461

Summary

The bilingual WebUI user guide added by PR #458 had several quality problems flagged in #461:

  • The Russian text was full of untranslated English UI terminology (e.g. "Token usage", "Pending approvals", "WebUI login fails") which made it feel half-translated rather than bilingual.
  • Several pages referenced screenshots that did not match the page they described (e.g. the Tools section showed dashboard widgets and a task delegation panel; Sessions showed the feedback dashboard).
  • Each section was 40–60 lines of high-level prose with no concrete UI mapping — pages were missing actual page layout, the buttons users click, the tabs they switch between, and the columns of the tables in front of them.
  • Several real WebUI pages were not mentioned at all (Workspace, Tasks, Workflows, Pipelines, Events, MCP, Network, Plugins, Self-Improve, Feedback).
  • The setup wizard and login screen were never shown — operators landed on the guide expecting to see what their first browser load looks like, and there was no screenshot.

This PR rewrites the entire docs/user-guide/ so that it actually matches the WebUI today.

What changed

  • README — rewritten with a clear preamble for both languages, calling out that the WebUI ships in English-only today and that Russian text uses the pattern «Русский перевод (English Label)» so operators can find the on-screen control.
  • Every section rewritten in both languages with parallel structure: page layout, exact tabs/columns, concrete actions, when-to-use guidance, recommended habits.
  • Russian text fully translated — no more leftover English fragments inside Russian sentences. Every UI noun is given as «Русский (English)» the first time it appears, then the translated form is used in prose.
  • Screenshot references fixed — each section now references screenshots from its own page only (Tools no longer points at dashboard captures; Hooks no longer points at integrations).
  • All real WebUI pages now covered, including Agents, Plugins, Memory, Workspace, Tasks, Workflows, Pipelines, Events, MCP, Integrations, Network, Feedback and Self-Improve in chapter 10.
  • Two new fresh screenshots captured from the bundled WebUI build: the login screen and the first step of the setup wizard. They live in docs/user-guide/assets/screenshots/common/.
  • Setup wizard now described step-by-step (Welcome → Provider → Config → Wallet → Telegram → Connect → Setup Complete) with the exact field names users see.
  • Quick Start, Troubleshooting and FAQ rewritten as concrete cookbooks with symptom → cause → step-by-step recovery rather than bullet-list summaries.

The Vitest documentation integrity test (src/docs/__tests__/user-guide.test.ts) still passes — the structural contract (13 sections × 2 languages, ≥30 screenshots per language, ≥5 diagrams, no broken local links) is preserved.

Visual evidence

Login screen captured from the current WebUI build:
Login screen

Setup wizard step 1 (Welcome):
Setup wizard

Verification

  • npx vitest run src/docs/__tests__/user-guide.test.ts — 3 tests pass
  • npm run lint — no warnings
  • npm run typecheck — passes (after npm run build:sdk)
  • npm test — full suite, 205 files, 3496 tests pass
  • Manual link audit: every relative [text](path) and ![alt](path) in docs/user-guide/**/*.md resolves to an existing file
  • Doc length grew from 1,430 lines to 3,305 lines (more than doubled) without bloating the structure — same 13 sections, no new top-level files

How to review

Pick any chapter and open both languages side by side. The recommended starts are:

  • docs/user-guide/en/01-quick-start.mddocs/user-guide/ru/01-quick-start.md — covers setup wizard, login, first task.
  • docs/user-guide/en/10-advanced-features.mddocs/user-guide/ru/10-advanced-features.md — the largest gap from the previous version (covers 13 pages that were under-documented or missing).
  • docs/user-guide/en/12-troubleshooting.mddocs/user-guide/ru/12-troubleshooting.md — converted from "checklist of bullets" into "symptom → diagnosis → fix" form.

Adding .gitkeep for PR creation (default mode).
This file will be removed when the task is complete.

Issue: xlabtg#461
konard added 2 commits April 28, 2026 16:03
…ced, settings, troubleshooting, FAQ + relocate fresh login/setup screenshots
@konard konard changed the title [WIP] Editing the complete user guide docs: rewrite WebUI user guide for accuracy and bilingual parity Apr 28, 2026
@konard konard marked this pull request as ready for review April 28, 2026 16:21
@konard
Copy link
Copy Markdown
Author

konard commented Apr 28, 2026

Solution summary

All CI checks pass (4/4 success). The PR is now ready for review.

Summary

PR #462 is ready for review. The bilingual WebUI user guide has been rewritten to address every concern in issue #461:

What was fixed

  • Untranslated Russian text — every page now uses fully translated prose with the «Русский (English)» pattern for UI labels, since the live UI is English-only.
  • Mismatched screenshots — each section now references screenshots from its own page (Tools no longer shows dashboards; Hooks no longer shows integrations).
  • Missing pages — the actual WebUI's 22 sidebar pages plus the 7-step setup wizard and login screen are now covered (previously Workspace, Tasks, Workflows, Pipelines, Events, MCP, Network, Plugins, Self-Improve and Feedback were not described).
  • Surface-level prose — every page now describes its actual layout (tabs, columns, buttons, fields) and gives concrete step-by-step procedures.
  • No login/setup imagery — fresh screenshots of the login screen and setup wizard captured from the bundled WebUI build are now in docs/user-guide/assets/screenshots/common/.

Numbers

  • Doc volume: 1,430 → 3,305 lines (more than doubled)
  • Test status: npx vitest run src/docs/__tests__/user-guide.test.ts → 3/3 pass; npm test → 3,496/3,496 pass; npm run lint clean; npm run typecheck clean
  • CI: 4/4 success on the upstream branch

PR URL: #462


This summary was automatically extracted from the AI working session output.

@konard
Copy link
Copy Markdown
Author

konard commented Apr 28, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost: $13.077673

📊 Context and tokens usage:

Claude Opus 4.7:

  • 229.8K / 1M (23%) input tokens, 105.1K / 128K (82%) output tokens

Total: (238.0K + 17.2M cached) input tokens, 105.1K output tokens, $12.721806 cost

Claude Haiku 4.5:

  • 15.0K / 64K (23%) output tokens

Total: (94.7K + 1.6M cached) input tokens, 15.0K output tokens, $0.355868 cost

🤖 Models used:

  • Tool: Anthropic Claude Code
  • Requested: opus
  • Main model: Claude Opus 4.7 (claude-opus-4-7)
  • Additional models:
    • Claude Haiku 4.5 (claude-haiku-4-5-20251001)

📎 Log file uploaded as Gist (6983KB)


Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
Copy link
Copy Markdown
Author

konard commented Apr 28, 2026

✅ Ready to merge

This pull request is now ready to be merged:

  • All CI checks have passed
  • No merge conflicts
  • No pending changes

Monitored by hive-mind with --auto-restart-until-mergeable flag

@xlabtg xlabtg merged commit 64c95b4 into xlabtg:main Apr 28, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Editing the complete user guide

2 participants