Skip to content

docs: Community Translation feature - #1130

Merged
Barush merged 12 commits into
mainfrom
jirikuchynka/community-translations-docs
Oct 19, 2026
Merged

Barush merged 12 commits into
mainfrom
jirikuchynka/community-translations-docs

Conversation

@Anty0

@Anty0 Anty0 commented Jul 18, 2026 •

Copy link
Copy Markdown
Member

Documents Community Translation end to end: public projects and community contributors in the platform (pitch tolgee/tolgee-platform#3806), and suggesting translations in context through the Tolgee Tools browser plugin (pitch tolgee/tolgee-platform#3780). It includes the changes from #1144, which was built on top of this branch and is merged into it.

The feature is released:

Part Release
Public projects Tolgee v3.206.0
Community translation switcher entry Tolgee v3.207.0
Community tab, Invite to Team Tolgee v3.215.0
Plugin sign-in on self-hosted (tolgee.oauth2.browser-extension-enabled) Tolgee v3.230.0
Suggestions in the in-context dialog @tolgee/web 7.3.0, Tolgee v3.227.0
Missing-permissions alert in the plugin Tolgee Tools v1.11.0

New pages

  • platform/translation_process/community-translation.mdx, the feature hub. It has a part for owners and members (making a project public and what that exposes, sharing it, reviewing suggestions, seeing who contributed, making it private again) and a part for contributors (what they can do, finding the projects they helped with). It also covers the self-hosted requirements: version floor, authentication and open registrations.
  • platform/translation_process/community-translation-in-context.mdx, for owners whose website uses the Tolgee JS SDK. It covers what to switch on in the project and on a self-hosted server, what to declare on the website (apiUrl, projectId, no apiKey), what contributors need, the Translate with Tolgee badge, and what contributors can do in the dialog.
  • platform/translate-with-tolgee.mdx is the page the badge links to, through the short link /translate-with-tolgee that static/_redirects points to it. It walks a first-time contributor through installing the plugin, signing in and Alt+clicking a string, and lists fixes for common problems.

Updated pages

  • js-sdk/in_context.mdx gets a new section, "Suggesting Translations in Context". It covers the Save / Suggest / Save & suggest button, the per-field notes, partial failures, reviewing suggestions in the dialog, suggest-only permissions and troubleshooting. A short paragraph links the sign-in section to it. The page is based on main's version from docs: sign in with a Tolgee account for the CLI, the browser extension and MCP clients #1151.
  • suggestions.mdx describes the two accept actions (Accept only and Accept and decline others) and the display of up to three suggestions with Show all. It notes that Suggestions mode off rejects new suggestions with suggestions_disabled (HTTP 409), and it documents the Delete own permission. It also corrects which permissions accepting and declining need.
  • project_settings.mdx gets a Public project section, and the Advanced screenshot is retaken and moved to the top of the section (see the review comments below).
  • members.mdx gets a Community Contributors section (the Team and Community tabs) and a community-permissions note.
  • sidebarPlatform.js: both community pages sit under Translation Process, and the contributor page sits under Get Started.

Review comments addressed

  • The page moved to Translation Process.
  • The open-source offer now names the free Business plan for non-commercial open source and links to mailto:sales@tolgee.io.
  • The lead paragraph is rewritten as who, what, how and what's next, with no links, and says "anyone with a Tolgee account".
  • Sections are grouped by owner and contributor point of view.
  • The full public projects URL is given, with the self-hosted equivalent.
  • The page says where the organization switcher is and when Community translation appears.
  • The community projects screenshot is explained: logged in, what My contributions only filters, and that Community translation is not a real organization.
  • Accept options and the Team and Community tabs are bullets.
  • The Advanced project settings screenshot was missing Public project and sat at the bottom of the section. It is retaken with Public project on top and moved directly under the section heading.
  • Read more from the settings page links to the "Making a Project Public" anchor.
  • The public project links on the Members page go to the "Making a Project Public" anchor instead of the page top.

Screenshots

These are captured against a local Tolgee v3.236.0 and the @tolgee/web test app, or reused from main.

Open

  • The short link redirects to the page on the deploy preview (/translate-with-tolgee answers 301 to /platform/translate-with-tolgee).
  • Tolgee Tools v1.11.0 is a GitHub pre-release. Confirm it is live in the Chrome Web Store and Firefox Add-ons before release notes point at the missing-permissions alert.
  • Optional: replace static/img/docs/platform/oauth/consent-screen-browser-extension.webp on the contributor page with a capture made as a contributor. The current one shows a user with edit rights.

The branch is up to date with main. Checked with npm run build, which throws on broken links and anchors.

@netlify

netlify Bot commented Jul 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for tolgee-docs ready!

Name Link
🔨 Latest commit 65fbbd4
🔍 Latest deploy log https://app.netlify.com/projects/tolgee-docs/deploys/6ad5d84e5e035a88c8c1b58f
😎 Deploy Preview https://deploy-preview-1130--tolgee-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@Anty0
Anty0 force-pushed the jirikuchynka/community-translations-docs branch from 5000564 to f756e51 Compare August 24, 2026 06:23
@Anty0
Anty0 marked this pull request as ready for review August 24, 2026 11:47
@Anty0
Anty0 requested a review from Barush August 24, 2026 11:48
Comment thread sidebarPlatform.js Resolved
Add a Community Translation page covering public projects, the community
permission, the public projects discovery page, reviewing community
suggestions, and unpublishing. Cross-link and update related pages:

- suggestions: two accept actions (Accept only / Accept and decline
  others) and the three-suggestions-with-Show-all display
- project_settings: Public project advanced setting
- members: community-permission note on public projects
- sidebar: new page entry
Cover the Contributors release (contributors tab, community projects
page, My contributions only toggle) and add UI screenshots to the
Community Translation, Suggestions, and Member Management pages.

- community_translation: contributors ('See who has contributed'),
  community projects page + 'My contributions only', screenshots for
  the public toggle, public projects page, community projects, the two
  accept actions, and the contributors tab
- members: 'Community contributors' section with the Team/Community tabs
- suggestions: screenshot of the two accept actions
…highlight

The ScreenshotWrapper renders window chrome, so interior crops looked
wrong. Retake the public toggle, contributors tab, community projects
page, and suggestion accept actions as full-viewport shots with the
relevant area outlined in red.
…out highlight

These two capture the page's main content, so no red highlight is
needed. Also fix their sizing: trim the excess width (side gutters) and,
for the contributors tab, the trailing vertical whitespace.
Condense the Community Translation and Member Management pages and fix
subject/verb and article agreement in the community-permissions wording.
Use the list view to match the other screenshots, and tighten the
highlight to just the Accept only button and the Accept and decline
others menu item.
- Move the Community Translation pages under Translation Process with
  kebab-case names, and rename the contributor page to
  translate-with-tolgee.mdx
- Restructure Community Translation by owner and contributor point of view,
  with a self-contained lead, numbered procedures, the exposure of a public
  project, who may accept and publish, and the self-hosted requirements
- Name the free Business plan for non-commercial open source with a
  mailto:sales@tolgee.io link
- Fill in the released versions, the suggestions_disabled status (409), and
  the plugin and dialog labels as the products spell them
- Build the in-context suggestions section on main's sign-in rewrite and
  link to oauth_sign_in.mdx instead of a second self-hosting section
- Retake the advanced project settings screenshot with Public project and
  move it to the top of the section; add a suggest-only dialog screenshot
…y-sdk-suggestions

# Conflicts:
#	js-sdk/in_context.mdx
@Anty0
Anty0 requested a review from Barush October 19, 2026 05:30
Comment thread js-sdk/in_context.mdx Resolved
Comment thread js-sdk/in_context.mdx Resolved
Comment thread js-sdk/in_context.mdx Resolved
@Barush
Barush merged commit 4717c28 into main Oct 19, 2026
6 checks passed
@Barush
Barush deleted the jirikuchynka/community-translations-docs branch October 19, 2026 09:10
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.

2 participants