Open
Conversation
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>
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
JanCizmar
commented
Apr 1, 2026
Contributor
Author
JanCizmar
left a comment
JanCizmar
left a comment
There was a problem hiding this comment.
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.
- 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>
JanCizmar
commented
Apr 1, 2026
- 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>
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
🤖 Generated with Claude Code