docs(translations): fix the context-hints intro and add a contribution path for non-developers - #15648
Merged
Conversation
Contributor
📖 Documentation Preview📄 1 changed documentation pageLast updated: Tue, 22 Sep 2026 13:59:35 GMT |
The opening of 'Provide context hints for translators' had three defects: a sentence fragment with no main clause, a duplicated 'which can which can be', and 'translations strings'. The closing line also ended in a colon that introduced nothing, since the block that follows is a warning rather than the promised example. Assisted-by: ClaudeCode:claude-opus-5 Signed-off-by: Anna Larch <anna@nextcloud.com>
…eckout Context hints are one of the few code changes worth making without a development environment, and translators are usually the people who notice that a string is ambiguous. The page explained what a TRANSLATORS comment looks like but assumed a local checkout, so there was nothing to point a translator at. Adds a section covering the GitHub web-editor route: the fork wall and what a fork is, that forking happens once and a stale fork needs syncing first, the commit dialog, the conventional-commit message and why a pre-filled suggestion usually needs a type prefix, the automatic DCO sign-off, avoiding lint failures that cannot be fixed from the web interface, who reviews and that outside contributors cannot add labels or assignees, where to tell the translation community, and that a merged hint only reaches Transifex at the next string sync. Four screenshots cover the steps where a newcomer is most likely to stop. Also states which languages actually require the TRANSLATORS prefix. The examples silently switched convention, which made the Qt and iOS ones read as omissions: they use their own markers, and TRANSLATORS there produces no hint at all. Assisted-by: ClaudeCode:claude-opus-5 Signed-off-by: Anna Larch <anna@nextcloud.com>
miaulalala
force-pushed
the
docs/translation-hints-contributor-workflow
branch
from
September 22, 2026 13:33
3ce0046 to
b65935e
Compare
rakekniven
approved these changes
Sep 22, 2026
Member
|
It does not show up at https://docs.nextcloud.com/server/stable/developer_manual/basics/translations.html#provide-context-hints-for-translators . The job runs at night, doesn't it? |
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
3 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.
☑️ Resolves
No issue - this came out of the translation sprint at Contributor Week, where the exercise was teaching community members with little or no git experience to contribute through the GitHub web UI.
🖼️ Screenshots
Four screenshots are added to the new section, at the points where a newcomer is most likely to stop: the fork wall, the editor banner naming their fork, the Sync fork button, and the commit dialog. They were taken with a fresh account with no write access; the commit email and an unrelated repository name are blurred.
📝 What is in here
Three things, all on
developer_manual/basics/translations.rst:which can which can be,translations strings, and a trailing colon introducing nothing.TRANSLATORSprefix. The examples silently switch convention: PHP, JS/TS and Vue need it, Android uses it by convention, and Qt and iOS use their own markers (//:,/* ... */) whereTRANSLATORSproduces no hint at all.nextcloud/desktopuses//:in 40 places against one use ofTRANSLATORS. Without the note, a reader would reasonably "fix" the Qt example and break extraction.✅ Checklist
codespellor similar and addressed any spelling issuessphinx-lintandcodespellboth report no problems on the changed file, and the manual builds with no new warnings.🤖 AI tool disclosure
Drafted with assistance from Claude Code (
claude-opus-5); every commit carries anAssisted-by:trailer. The prose and structure were reviewed and corrected by me.