feat: add translation memory management page#1100
Merged
Merged
Conversation
Cover org-level shared and project-only memories, manual entries, TMX import/export, project assignment, and write rules. Refresh the existing translation_memory page to describe the redesigned editor panel and link to the new management page. Add the new page to the Translation Process sidebar.
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The "Configure write rules" section slugifies to #configure-write-rules, not #write-rules. Docusaurus broken-anchors check fails the build.
dkrizan
changed the title
Sidebar restructure: turn the single Translation Memory entry into a category landing on translation_memory.mdx, with two children labelled "Matches in the editor" (translator-facing) and "Manage memories" (admin-facing). Page titles unchanged.
When the category links to translation_memory.mdx, listing the same doc as a child makes the parent header and the first sub-item point to the same URL. Keep only Manage memories as a child so the category header itself serves as the link to the editor-side page.
Reworks the two TM pages with updated scope, terminology, and structure
so they reflect the management UI as it ships today.
managing_translation_memories.mdx
- Drop the 'feature must be enabled for the UI to appear' line — the
list page is visible regardless of plan; only shared-memory creation
is gated.
- Memory types: clarify that project-only memories accept manual and
TMX entries on top of their auto-populated content, and that shared
memories only reflect a project's translations when that project has
write access. Inline the comparison table next to the prose.
- 'Fill a memory' subsections reordered and renamed to match the empty-
state wizard (Sync from projects → Import from file → Add manually).
Each cross-references the wizard card and the toolbar entry-point.
- 'Assign a memory to projects' simplified: org-settings-only flow, no
duplicate project-settings path; columns inlined as bullets.
- Tail restructured: dropped the umbrella 'Reference' section. 'Who
can do what' (was Permissions) and 'TMX format' are now top-level.
- 'Suggestion ordering' and 'Suggestions vs auto-translate' moved to
the parent translation_memory.mdx page.
translation_memory.mdx
- Adds an admonition stating TM only operates on the default branch,
linking to the Branching docs.
- New 'Auto-translate from memory' section contrasts the editor
suggestion panel with auto-translate / pre-translate by TM, and
notes the reviewed-only-mode exclusion.
- Small wording softening (curate, authoritative → simpler verbs).
Inline {/* TODO screenshot: ... */} comments throughout describe the
exact scene each placeholder should capture.
Fixes Netlify deploy preview by repointing the two anchors that broke after sections moved/renamed in 6e96747. Also incorporates accumulated copy fixes: priority column removed from the assignment table doc, toggle label and behavior corrected, base-language constraint surfaced as an info admonition, second route to TM settings noted.
Adds the five new captures for the management page and refreshes the editor TM panel image to show the redesigned layout (score chip with color tier, TM name, relative age, target + source). Removes the inline TODO screenshot guidance blocks now that the captures are in place.
Barush
reviewed
May 20, 2026
docs: address review feedback and restructure Manage TM page - Apply 19 review comments (rewrites, renames, terminology fixes) - Restructure around the user journey: types → list → create → browse → fill → edit → share → delete → FAQ → reference - Add inline permission callouts; keep recap table at the bottom - Add empty-memory wizard screenshot
docs: split Translation Memory parent into Use + Manage child pages The Translation Memory sidebar parent was the only category with a content link. Every other multi-page topic (Branching, MCP Server, Slack Integration…) uses a pure category with child docs. Match that pattern: turn the parent into a pure category and make the existing runtime-view content a child page. - Rename translation_memory.mdx -> using_translation_memory.mdx - Drop `link:` on the Translation Memory category in sidebarPlatform - Redirect /platform/translation_process/translation_memory -> /platform/translation_process/using_translation_memory - Update internal links in editing_translations and managing pages
docs: tighten TM page prose and add Use TM FAQ - Replace em-dashes throughout with colons, commas, and periods - Trim Edit entries section to entry-level actions; add a Sync-locked entries note - Reorder Browse-entries toolbar bullets; add Export TMX - Wire in the empty-memory wizard screenshot - Add 4 runtime FAQs to the Use translation memory page (TM vs MT, why no matches, auto-translate gotcha, real-time updates)
+ minor changes in TM docs
3 tasks
dkrizan
added a commit
to tolgee/tolgee-platform
that referenced
this pull request
May 27, 2026
## Summary - Adds a new `FEATURE_TRANSLATION_MEMORY_MANAGEMENT` announcement (active until 2026-07-01) linking to the new [Manage Translation Memories](https://docs.tolgee.io/platform/translation_process/managing_translation_memories) doc. - Regenerates the frontend API schema for the new enum value. Companion doc PR: tolgee/documentation#1100 The translation key `announcement_translation_memory_management` will be created in the Tolgee project before merge. ## Test plan - [x] Verify banner renders on an org that hasn't dismissed it yet - [x] Verify the link opens the new docs page - [x] Confirm the key exists in Tolgee with an English translation <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added support for a translation memory management announcement feature. When activated on July 1, 2026, users will receive an in-app notification with relevant documentation link. <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/tolgee/tolgee-platform/pull/3692?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
TolgeeMachine
added a commit
to tolgee/tolgee-platform
that referenced
this pull request
May 27, 2026
](https://app.coderabbit.ai/change-stack/tolgee/tolgee-platform/pull/3692?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack){kind=link}
# [3.193.0](v3.192.0...v3.193.0) (2026-05-27) ### Bug Fixes * allow API key access to get-modified-entities-by-revision endpoint ([#3697](#3697)) ([a314585](a314585)), closes [#2284](#2284) ### Features * announcement banner for Translation Memory management ([#3692](#3692)) ([afde9b3](afde9b3)), closes [tolgee/documentation#1100](tolgee/documentation#1100) * include projectId in webhook payload ([#3695](#3695)) ([20f291b](20f291b))
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
2 participants
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.
Status
Draft — work in progress. Picking this up: see the Handoff section at the bottom.
This PR reworks the two Translation Memory pages to match the management feature that ships on the platform
dkrizan/translation-memory-managementbranch. The structure and copy are largely stable; what's still open is screenshots and a couple of small wording choices the original author wanted to make in person.What's new in this PR
platform/translation_process/managing_translation_memories.mdxFull rework. Final outline:
Subsection order under Fill a memory matches the empty-state wizard in the app (
Sync from projects/Import from file/Add manually), using the same labels the wizard uses.platform/translation_process/translation_memory.mdx:::infoadmonition at the top: Translation Memory only operates on the project's default branch (links to/platform/branching/overview).## Auto-translate from memorysection explaining the difference between the editor's suggestion panel (fuzzy, penalised) and auto-translate / pre-translate (exact, must have no penalty).curate/authoritative→ plainer verbs).Screenshots — still to capture
Each
ScreenshotWrapperplaceholder is preceded by a{/* TODO screenshot: <filename> */}MDX comment describing the exact scene that shot should capture. All comments are MDX (so they don't render in the published page).translation-memories-list.webpcreate-translation-memory.webpimport-tmx-dialog.webpadd-entry-dialog.webpassigned-projects-table.webpUsed in projectstable with mixed Read/Write/PenaltyA test org with 3 shared memories (Common UI / Marketing voice / Legal & compliance) plus 3 projects (Web App / iOS App / Marketing Site) is the suggested staging — seed TMX files for that setup live in the platform workspace at
tmp/seed-common-ui.tmx,tmp/seed-marketing-voice.tmx,tmp/seed-legal-compliance.tmx(commit before the PR is finalised, or delete the references if they don't make it across).A 6th, optional screenshot (
editor-tm-suggestions.webp) could go on the parent page to illustrate a mix of high- and lower-trust matches in the editor panel — not committed to in the doc yet.Open questions / unfinished choices
## Auto-translate from memorycurrently reads "Exact equality and the memory carries no penalty for the receiving project". Three candidates were discussed; pick one before publishing:Exact equality (considering penalty)Exact equality, with no penalty appliedExact equality on a memory with no penaltyTranslation Memoryfrom earlier commits; verify the order still makes sense once these pages are published.Verification
docusaurus startand sanity-check the rendering of both pagesmanaging_translation_memories.mdx→translation_memory.mdx#auto-translate-from-memoryresolvestranslation_memory.mdx→/platform/branching/overviewresolvesHandoff notes
This PR is currently authored against the in-flight platform feature on
dkrizan/translation-memory-management(PR tolgee/tolgee-platform#3596). The doc copy was verified against the implementation there as of the last commit on this branch.If you're picking this up:
{/* TODO screenshot: ... */}block; capture the screenshot as instructed; replace the placeholder file atstatic/img/docs/platform/translation-memory/<name>.webp.