docs: add QA checks documentation by JanCizmar · Pull Request #1090 · tolgee/documentation

JanCizmar · 2026-04-01T14:33:19Z

Summary

Add new documentation page for the QA Checks feature under Translation Process
Covers all 17 check types (comparison + syntax), configuration at project and language level, real-time preview, and batch processing
Includes placeholder comments for screenshots and videos to be added later
Adds sidebar entry under Translation Process

Test plan

Review content accuracy against the QA checks implementation
Add screenshots for all placeholder locations
Verify sidebar navigation works correctly
Check all links resolve properly

🤖 Generated with Claude Code

netlify · 2026-04-01T14:33:27Z

✅ Deploy Preview for tolgee-docs ready!

Name	Link
🔨 Latest commit	`c9906bf`
🔍 Latest deploy log	https://app.netlify.com/projects/tolgee-docs/deploys/69d926991148920008864c5c
😎 Deploy Preview	https://deploy-preview-1090--tolgee-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

JanCizmar

Overall, I would like to be more detailed, and it should read more like a book. We should explain why the QA checks are usefull and what user problems does it solve.

platform/translation_process/qa_checks.mdx

Anty0 · 2026-04-04T17:12:37Z

Lookin' good ^^

I'll update a few things - defaults have been changed, and there's now one more check.

Question: I planned to have a separate page for each check to show how it works. I wanted to include a note about limitations for the language tool-based checks. Is that a good idea, or should we drop it for now? If we drop it, should I add a note about the language tool somewhere on the existing page and link to it from the app, or do you have any better ideas?

platform/translation_process/qa_checks.mdx

Add documentation for the QA Checks feature covering check types, configuration, real-time preview, and batch processing. Includes placeholders for screenshots and videos to be added later. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Move feature intro before availability callout, explain the problem first - Change "paid plans" to "advanced plans" - Fix self-hosted licensing link - Add intro paragraph to "Enabling QA Checks" section - Remove check count number - Create separate QA Check Types page with detailed descriptions - Add context to "Viewing QA Issues" explaining why it's shown in editor - Remove colons before lists - Add motivation to "Ignoring Issues" section - Add motivation to "Language-Level Overrides" section - Rename "How QA Checks Run" to "When QA Checks Run", consolidate into prose - Remove em dashes - Remove duplicate "Batch Operations" section Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- "Unmatched newlines" → "Unmatched new lines" (two words) - "Unbalanced brackets" → "Brackets unbalanced" (word order) - Add missing "Unresolved comments" check type Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Add keywords to titles and meta descriptions (translation quality, localization, spelling, grammar) - Add cross-links to related pages: ICU message format, languages, keys character limit, import, batch operations, branching, comments, placeholders - Document plural translation behavior (checks run per variant) - Document default severity values (most default to Warning) - Clarify language override precedence - Explain spinner badge state (after import or settings change) - Add back-link from check types page to main QA checks page Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Replace "ICU syntax" with "ICU placeholders" in intro text - Remove check type tables from main page (dedicated page exists) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Replace "ICU placeholder" with plain "placeholder syntax" to be more accessible to users unfamiliar with the ICU standard. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Format menu items, buttons, and settings sections with backticks instead of bold, matching the documentation convention for referencing UI elements. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Merge check types back into main QA checks page (remove separate page) - Revert sidebar to single entry - Add screen recordings: enable, translations view, spinner, correct, ignore, project settings, language settings, batch recheck - Rename "Comparison Checks" to "General Checks" (not all compare) - Fix default severities: Spelling and Grammar default to Off - Move Unresolved comments to General Checks - Fix QA badge description (no checkmark, badge hides when 0 issues) - Fix plural section (remove ICU mention) - Use backticks for UI elements Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

- Add severity note (italic) explaining only Warning/Off supported - Clarify manual recheck is last resort, system handles it automatically - Remove original mp4 source files Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…ar checks - Add self-hosting note to QA checks page about LanguageTool requirement - Add "Optional: Spelling & Grammar checks" section to running_with_docker with docker-compose example and config.yaml setup

Add a dedicated section explaining what spelling and grammar checks can and cannot do, covering language coverage, false positives on short text, and automatic filtering of placeholders/glossary terms. Also fix ignoer.webm typo and add cross-reference from settings section.

JanCizmar marked this pull request as draft April 1, 2026 14:52

JanCizmar commented Apr 1, 2026

View reviewed changes

platform/translation_process/qa_checks.mdx Outdated Show resolved Hide resolved

platform/translation_process/qa_checks.mdx Outdated Show resolved Hide resolved

platform/translation_process/qa_checks.mdx Outdated Show resolved Hide resolved

JanCizmar marked this pull request as ready for review April 3, 2026 11:06

JanCizmar requested a review from Anty0 April 3, 2026 11:07

Anty0 reviewed Apr 7, 2026

View reviewed changes

platform/translation_process/qa_checks.mdx Outdated Show resolved Hide resolved

Anty0 reviewed Apr 7, 2026

View reviewed changes

platform/translation_process/qa_checks.mdx Outdated Show resolved Hide resolved

Anty0 approved these changes Apr 8, 2026

View reviewed changes

Anty0 force-pushed the jancizmar/qa-checks-docs branch from 6148d0b to 80f21f5 Compare April 9, 2026 08:40

JanCizmar and others added 14 commits April 10, 2026 18:34

docs: address second round of PR feedback

4ffebfc

- Replace "ICU syntax" with "ICU placeholders" in intro text - Remove check type tables from main page (dedicated page exists) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: remove ICU terminology from QA checks intro

9322dd1

Replace "ICU placeholder" with plain "placeholder syntax" to be more accessible to users unfamiliar with the ICU standard. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: use backticks for UI elements in QA checks docs

0ad4b02

Format menu items, buttons, and settings sections with backticks instead of bold, matching the documentation convention for referencing UI elements. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: remove LanguageTool mention from check descriptions

c459d41

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: add inline highlights screen recording

7aa7ff2

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: final polish for QA checks page

22bad13

- Add severity note (italic) explaining only Warning/Off supported - Clarify manual recheck is last resort, system handles it automatically - Remove original mp4 source files Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs: add LanguageTool container setup for self-hosted spelling/gramm…

0a3eebb

…ar checks - Add self-hosting note to QA checks page about LanguageTool requirement - Add "Optional: Spelling & Grammar checks" section to running_with_docker with docker-compose example and config.yaml setup

docs: add QA checks overview screenshot to translation editor docs

c9906bf

Anty0 force-pushed the jancizmar/qa-checks-docs branch from 80f21f5 to c9906bf Compare April 10, 2026 16:34

Anty0 merged commit fe44d46 into main Apr 10, 2026
6 checks passed

Anty0 deleted the jancizmar/qa-checks-docs branch April 10, 2026 16:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add QA checks documentation#1090

docs: add QA checks documentation#1090
Anty0 merged 14 commits intomainfrom
jancizmar/qa-checks-docs

JanCizmar commented Apr 1, 2026

Uh oh!

netlify bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

JanCizmar left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Anty0 commented Apr 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

JanCizmar commented Apr 1, 2026

Summary

Test plan

Uh oh!

netlify bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for tolgee-docs ready!

Uh oh!

JanCizmar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Anty0 commented Apr 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Apr 1, 2026 •

edited

Loading