docs: rewrite WebUI user guide for accuracy and bilingual parity#462
docs: rewrite WebUI user guide for accuracy and bilingual parity#462xlabtg merged 4 commits intoxlabtg:mainfrom
Conversation
Adding .gitkeep for PR creation (default mode). This file will be removed when the task is complete. Issue: xlabtg#461
… tools, soul (EN+RU)
…ced, settings, troubleshooting, FAQ + relocate fresh login/setup screenshots
Solution summaryAll CI checks pass (4/4 success). The PR is now ready for review. SummaryPR #462 is ready for review. The bilingual WebUI user guide has been rewritten to address every concern in issue #461: What was fixed
Numbers
PR URL: #462 This summary was automatically extracted from the AI working session output. |
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost: $13.077673📊 Context and tokens usage:Claude Opus 4.7:
Total: (238.0K + 17.2M cached) input tokens, 105.1K output tokens, $12.721806 cost Claude Haiku 4.5:
Total: (94.7K + 1.6M cached) input tokens, 15.0K output tokens, $0.355868 cost 🤖 Models used:
📎 Log file uploaded as Gist (6983KB)Now working session is ended, feel free to review and add any feedback on the solution draft. |
✅ Ready to mergeThis pull request is now ready to be merged:
Monitored by hive-mind with --auto-restart-until-mergeable flag |
This reverts commit 7ae21be.
Fixes #461
Summary
The bilingual WebUI user guide added by PR #458 had several quality problems flagged in #461:
This PR rewrites the entire
docs/user-guide/so that it actually matches the WebUI today.What changed
docs/user-guide/assets/screenshots/common/.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:

Setup wizard step 1 (Welcome):

Verification
npx vitest run src/docs/__tests__/user-guide.test.ts— 3 tests passnpm run lint— no warningsnpm run typecheck— passes (afternpm run build:sdk)npm test— full suite, 205 files, 3496 tests pass[text](path)andindocs/user-guide/**/*.mdresolves to an existing fileHow to review
Pick any chapter and open both languages side by side. The recommended starts are:
docs/user-guide/en/01-quick-start.md↔docs/user-guide/ru/01-quick-start.md— covers setup wizard, login, first task.docs/user-guide/en/10-advanced-features.md↔docs/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.md↔docs/user-guide/ru/12-troubleshooting.md— converted from "checklist of bullets" into "symptom → diagnosis → fix" form.