Skip to content

docs(i18n): document translator context hints in developer manual - #124

Merged
vitormattos merged 1 commit into
mainfrom
docs/translator-context-guide-20261105
Nov 5, 2026
Merged

vitormattos merged 1 commit into
mainfrom
docs/translator-context-guide-20261105

Conversation

@vitormattos

Copy link
Copy Markdown
Member

Summary

Make LibreSign's Translation developer-manual page the canonical place for contributor guidance on source-string translations and TRANSLATORS hints.

The LibreSign application PR #9364 previously added this detailed guidance to CONTRIBUTING.md. This PR keeps the durable documentation in the documentation repository; #9364 will retain only a short link to this page and its existing automated lint safeguard.

Changes

  • Extend the existing developer_manual/translation.rst page, retaining its Transifex instructions.
  • Explain the LibreSign style convention (TRANSLATORS without a colon), where hints belong, when separate hints are needed, and why same-line conditional translations are ambiguous to the Nextcloud extractor.
  • Include concrete TypeScript and Vue examples and the exact lint and checker-test commands.
  • Link Translation from the developer manual's start page.

No translation catalog, generated Sphinx HTML, or screenshot images are committed to the repository.

Rendered documentation

Screenshots captured with Chromium/Playwright from the actual Sphinx-generated HTML of this branch:

Rendered translator-hint conventions in the LibreSign developer manual

Full Translation page — rendered output

Full rendered Translation developer manual page

Validation

  • sphinx-build -W developer_manual _build/developer_manual — passed, no warnings.
  • Verified the rendered Translation page contains the new section, source examples, and lint commands.
  • Captured and visually inspected the real rendered page; browser had no page errors.
  • git diff --check — passed.

Cross-repository coordination: Review alongside LibreSign/libresign#9364, which will replace the duplicated CONTRIBUTING.md tutorial with a link to this page. No merge is requested as part of this PR.

translation-conventions

translation-guide-full

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit e78388d into main Nov 5, 2026
2 checks passed
@vitormattos
vitormattos deleted the docs/translator-context-guide-20261105 branch November 5, 2026 03:35
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.

1 participant