Skip to content

Add the Polish documentation language pack - #4235

Merged
SpicyMarinara merged 4 commits into
stagingfrom
agent/docs-language-pl
Jul 29, 2026
Merged

Add the Polish documentation language pack#4235
SpicyMarinara merged 4 commits into
stagingfrom
agent/docs-language-pl

Conversation

@kolacheee

@kolacheee kolacheee commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

Linked issue\n\nCloses #4258\n\n## Why

Language #6 of the plan to cover every interface language with a documentation pack, following Spanish (#4100), German (#4157), French (#4191), and Brazilian Portuguese (#4229). Content lives on the companion docs-i18n branch (pl/ + sha256 manifest) and downloads on demand — zero checkout or image weight.

What changed

  • packages/shared/src/constants/docs-languages.ts: pl: { label: "Polski", englishLabel: "Polish" }.
  • packages/client/src/components/modals/DocsViewerModal.tsx: Polish sidebar category labels (Przewodniki, Start, Połączenia, Postacie, Czaty, Ustawienia, …; mode names Conversation/Roleplay/Game Mode stay English to match the UI).
  • packages/client/src/components/panels/SettingsPanel.tsx: settings-search aliases "polish", "polski".
  • scripts/regressions/docs-language.regression.ts: Polish assertion.
  • CONTRIBUTING.md: Polish per-language conventions; CHANGELOG.md: Unreleased entry.
  • Companion (on docs-i18n, not part of this diff): pl/** — all 123 guides with a generated manifest.

Translation approach

Same naturalness-first method as the previous packs, with two Polish-specific policies decided up front:

  • Declension: Polish inflects nouns, and a declined product name fragments the literal substring search ("Marinarze" doesn't contain-match "Marinara"). Product names therefore stay frozen/undeclined, with a declinable carrier noun where the case demands ("w aplikacji Marinara Engine") — while assimilated loanwords decline normally, as real Polish requires (promptu, tokenów, czatów). The sweep audits for declined product-name forms mechanically.
  • Reader gendering: Polish past-tense verbs encode gender; the style brief mandates constructions that never force the reader's gender (present tense, imperatives, "można"/"warto").

Also: informal "ty" with second-person imperatives (matching the informal-register precedent across all packs and Polish consumer-software convention), the assimilated form czat standardized in prose, straight ASCII quotes only (never „…" — the app's own Quote style default is Straight, and mixed quote forms split search hits), no non-breaking spaces, English UI labels in bold with a one-time Polish gloss, and mechanical link-text↔H1 verification to zero paraphrases. Every file passed structural verification, the declension/address/typography/terminology sweeps, and an independent language-QA panel.

Validation done

  • pnpm check and pnpm regression:docs green (regression reports en, de, es, fr, pl, pt-br).
  • scripts/docs-i18n/validate-pack.mjs + build-manifest.mjs green on pl/.
  • Runtime-verified against a throwaway data dir with a materialized pack: viewer fully Polish (categories, titles, search with diacritics), Settings coverage counts, switch flows.

Summary by CodeRabbit

  • New Features

    • Added Polish (pl) as a documentation language option.
    • Polish documentation now shows Polish sidebar category headings, including translated in-app guide sections.
    • You can install it from Settings → General → Documentation Language → Download & Replace.
    • The “Documentation Language” setting can be found by searching “Polish” or “Polski”.
  • Documentation

    • Added Polish translation guidelines for contributors.

Adds the pl label row (Polski, matching the interface Language
dropdown), Polish sidebar category labels in the docs viewer,
settings-search aliases, the per-language conventions in CONTRIBUTING
(including the frozen product-name declension policy), a regression
assertion, and the changelog entry. The pack itself lives on the
docs-i18n branch and must be pushed before this merges.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b7cfe97a-e972-449b-8c80-858acb9f0455

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The Polish documentation language pack was registered across shared constants, settings search, and documentation navigation. Regression coverage, changelog information, and Polish translation guidelines were also added.

Changes

Polish documentation language

Layer / File(s) Summary
Language registration and UI integration
packages/shared/src/constants/docs-languages.ts, packages/client/src/components/panels/SettingsPanel.tsx, packages/client/src/components/modals/DocsViewerModal.tsx
Adds Polish labels, search aliases, and translated documentation directory headings.
Validation and translation guidance
scripts/regressions/docs-language.regression.ts, CONTRIBUTING.md, CHANGELOG.md
Checks that pl is supported and documents Polish translation conventions and installation details.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • Pasta-Devs/Marinara-Engine#4100: Extends the documentation language infrastructure introduced by this PR by adding Polish language metadata, navigation labels, settings aliases, and regression coverage.

Suggested labels: feature, ci

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly states the main change: adding the Polish documentation language pack.
Linked Issues check ✅ Passed The changes register Polish docs metadata, localize viewer categories, add search aliases, document conventions, and add regression coverage.
Out of Scope Changes check ✅ Passed All changed files support the Polish documentation language feature and its documentation/validation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/docs-language-pl

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@kolacheee

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot added ci feature New feature or enhancement labels Jul 29, 2026
@github-actions github-actions Bot removed the ci label Jul 29, 2026
@SpicyMarinara SpicyMarinara self-assigned this Jul 29, 2026
@SpicyMarinara
SpicyMarinara self-requested a review as a code owner July 29, 2026 12:57
SpicyMarinara
SpicyMarinara previously approved these changes Jul 29, 2026

@SpicyMarinara SpicyMarinara left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Owner approval at the refreshed head after successful pnpm-validate and container checks. The earlier install timeout was transient and the clean rerun passed; CodeRabbit has no outstanding findings.

@SpicyMarinara SpicyMarinara left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Owner approval at reconciled head 5e8533e. The CHANGELOG conflict preserves both entries, Settings retains Polish aliases and tracker controls, CodeRabbit has no unresolved findings, and fresh container plus pnpm-validate checks passed.

@SpicyMarinara

Copy link
Copy Markdown
Collaborator

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@SpicyMarinara
SpicyMarinara merged commit ca6a804 into staging Jul 29, 2026
21 of 25 checks passed
@SpicyMarinara
SpicyMarinara deleted the agent/docs-language-pl branch July 29, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

client docs feature New feature or enhancement shared

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants