Skip to content

Docs: Slovak translation (/sk/) and versioned docs with a 5.x archive - #157

Merged
tomaj merged 1 commit into
masterfrom
docs/slovak-versioned
Oct 23, 2026
Merged

tomaj merged 1 commit into
masterfrom
docs/slovak-versioned

Conversation

@tomaj

@tomaj tomaj commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Closes #76

Summary

  • Slovak translation of every page under /sk/ (39 pages: guide, all six drivers including FileSystem and Kafka, examples, frameworks, API, FAQ, changelog, contributing, authors, versioning, 5.x archive). VitePress locales: English stays the default at the root (en-US), Slovak is sk at /sk/, same paths (/guide/retry ↔ /sk/guide/retry). The top bar has a language menu, like bank-mails-parser.
  • Slovak UI: nav, sidebars, search, outline, prev/next, edit link, 404, and every custom component (hero, use cases, worker demo, compare table, project source, authors, diagram dialog) via docs/.vitepress/theme/i18n.ts.
  • SEO: every page has hreflang en/sk/x-default links, og:locale plus the alternate, <html lang="sk">, and Slovak FAQPage/HowTo JSON-LD (## Časté otázky, ## N. … steps with matching anchors).
  • Versioned docs: the root is the latest version (6.x). The version menu (6.x (latest), 5.x, Versioning) shows the version from the path. Older majors live in /<major>.x/ and /sk/<major>.x/. guide/versioning.md explains how to archive 6.x when 7.x comes.
  • New check: docs/scripts/check-locales.py, which npm run docs:links runs, fails when a page exists in only one language.
  • Rebased onto current master (after Add FileSystemDriver: a queue in a local directory #154 FileSystem and Add KafkaDriver for Apache Kafka through ext-rdkafka #155 Kafka). Slovak FileSystem + Kafka driver pages added; SK nav/sidebar updated; EN+SK copy brought in line with six built-in drivers.

Review log (preview verify + full EN/SK audit, 2026-10-23)

Rebuilt VitePress from head a548947; served locally; refreshed screenshots under /workspace/previews/157-verify-*.png.

Previews look correct: language menu (Slovenčina/English), version menu EN 6.x (latest) / 5.x / Versioning and SK 6.x (aktuálna) / 5.x / Verzie, EN+SK homes (six drivers in hero), filesystem SK, kafka SK, comparison SK (six-column table + driver cards), sidebar lists all six drivers, 5.x archive EN+SK (SK chrome + EN README body as designed). No broken UI.

Audit (both locales): check-locales 39/39; docs:links green (~379); FAQ ### counts match on every page pair (SK section title Časté otázky); heading counts match; all eight driver routes EN+SK present; hreflang en/sk/x-default + og:locale correct on sampled pages including FS/Kafka/5.x; i18n en/sk key sets equal. No content fixes required this round; commit unchanged.


Review log (thorough re-review round, 2026-10-23)

Multi-angle pass on head after prior merge-ready prep. Already on current master (no rebase needed).

OK (clean):

  • check-locales 39/39; npm run docs:links green (diagrams, snippets, locales, SVG, edit/blob/tree links, linkinator 379 links)
  • FS + Kafka SK pages present; heading/diagram/snippet parity with EN; SK nav/sidebar lists all six drivers; comparison table has six columns
  • Language + version menus (navEn/navSk, /5.x/ + /sk/5.x/ sidebars); i18n.ts key parity 47/47
  • SEO: hreflang en/sk/x-default, og:locale + alternate, <html lang>, FAQPage JSON-LD on FAQ pages; no <<< snippet leak in JSON-LD
  • Versioning + 5.x archive (README + known mistakes; SK wraps EN README in lang="en"); frameworks keep intentional four-driver factory set
  • Internal SK fragment links verified against built HTML ids

Fixed this round:

  1. SK examples/index.md was missing the "Are the examples tested?" FAQ and the CI sentence before the FAQ section — restored for EN/SK FAQ parity (6/6).
  2. docs/contributing.md + docs/sk/contributing.md still said three brokers / "all four variables" after Kafka landed; aligned with root CONTRIBUTING.md / composer test:integration (HERMES_TEST_KAFKA, five variables). Punctuation fix in root CONTRIBUTING.md.
  3. CHANGELOG Unreleased Fixed bullet updated for the above.

Second pass after fixes: FAQ/heading counts match; docs:links still green. Single commit amended (a548947), Tomas Majer.


Review log (merge-ready pass on current master)

  1. Rebased docs/slovak-versioned onto origin/master (8f4a5c5, post-Add FileSystemDriver: a queue in a local directory #154/Add KafkaDriver for Apache Kafka through ext-rdkafka #155). Conflicts in faq.md / overview.md resolved keeping master FileSystem + Kafka content.
  2. Added docs/sk/guide/drivers/filesystem.md and docs/sk/guide/drivers/kafka.md.
  3. Updated Slovak sidebar (sidebarSk in docs/site-nav.ts) with FileSystem and Kafka entries.
  4. Brought SK pages up to six-driver parity: overview, home, FAQ, architecture, delayed, priority, retry, getting-started, extending, API reference, shutdown, deployment, concepts, examples (webhooks, reminder, priority), contributing, index.
  5. EN review fixes found while aligning locales (stale “four drivers” / missing FileSystem or Kafka):
    • guide/drivers/overview.md delayed/ack FAQs
    • guide/delayed.md FAQ + where-stored + description
    • home: “Six built-in drivers” + retry/priority feature text
    • examples/priority.md
    • guide/deployment.md FileSystem rename note
  6. CHANGELOG.md [Unreleased] Fixed bullet for six-driver docs consistency.
  7. Left intentional: frameworks still describe the four classic drivers (Redis ×2 + RabbitMQ + SQS) to match EN; contributing “all four variables” is about env vars for Redis/RabbitMQ/SQS/Require, not driver count; diagrams stay English; code blocks untranslated.
  8. npm run docs:links (local): green — check-locales ok 39 pages, linkinator clean.
  9. Single commit, author Tomas Majer <tomasmajer@gmail.com>. Force-pushed with --force-with-lease.

Decisions to review

  1. 5.x archive = the 5.0.0 README on one page (/5.x/, /sk/5.x/).
    • 5.x never had a docs site. Copying the 6.x guide would document behaviour 5.x does not have (ack after the handler, priority order, the delayed-message fix).
    • The README is kept verbatim. It is in English on the SK page too, wrapped in lang="en", with a Slovak notice.
    • A "Known mistakes in the 5.0.0 README" list covers: priority passed as the message id, new missing on the shutdown classes, RedisShutdown given a Predis client, retry being instant on RabbitMQ/SQS, and RedisSetDriver never delivers delayed and retried messages (SPOP on a sorted set) #95.
    • The only change to the text is the five dead http:// links, which now point to their current https addresses so the link check passes.
  2. Diagrams stay English: the SVGs are shared between the locales and the labels are mostly code. The alt texts are translated.
  3. Code blocks are not translated, including their English comments. They are imported from examples/, so both languages show the same files.
  4. The versioning page mentions 5.1 (5.1.0: deprecate APIs that change in 6.0 #156) as "not released yet". 5.1.0: deprecate APIs that change in 6.0 #156 is deferred for now; leave the wording until that release lands.
  5. No noindex on the archive. It is the only 5.x documentation, and /sk/5.x/ uses hreflang to point at /5.x/.
  6. Six drivers in comparison / home / FAQ after Add FileSystemDriver: a queue in a local directory #154/Add KafkaDriver for Apache Kafka through ext-rdkafka #155; frameworks pages keep the historical four-driver integration set on purpose.

Verification

  • npm run docs:links: all green, including diagrams:check, check-snippets, check-locales (39 pages in both languages), build, check-svg, edit/blob/tree links and linkinator over the whole site at /hermes/.
  • Local check-locales: ok 39 pages in English and Slovak.
  • No PHP code changed, so Infection does not apply.
  • CI on head a548947 after force-push: all required checks green (Docs links and SVG with check-locales 39, PHP 8.4/8.5/prefer-lowest, Infection, Rector, PHPStan, CodeQL, Examples including filesystem + kafka). One Example csv-import fail was a RabbitMQ container eacces on .erlang.cookie (infra flake, unrelated to docs); re-ran failed Examples jobs → pass.

Previews

Captured under /workspace/previews/ (open locally; not hosted externally):

  • 157-home-en-six-drivers.png — EN home, six drivers
  • 157-home-sk-six-drivers.png — SK home, six drivers
  • 157-drivers-comparison-sk.png — SK drivers comparison with FileSystem + Kafka
  • 157-filesystem-sk.png — SK FileSystem driver page
  • 157-kafka-sk.png — SK Kafka driver page
  • 157-nav-sk-lang-version.png — SK chrome with language + version controls
  • Earlier switcher / archive shots still apply: 76-language-switcher.png, 76-version-switcher.png, 76-version-switcher-sk.png, 76-sk-home.png, 76-sk-page.png, 76-5x-archive.png, 76-5x-archive-sk.png

Merge notes

@tomaj tomaj added this to the 6.0.0 milestone Oct 22, 2026
@tomaj tomaj self-assigned this Oct 22, 2026
@coveralls

coveralls commented Oct 22, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 39981778822

Coverage remained the same at 98.78%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 656
Covered Lines: 648
Line Coverage: 98.78%
Coverage Strength: 22.27 hits per line

💛 - Coveralls

@tomaj
tomaj force-pushed the docs/slovak-versioned branch from fe71d99 to dd37258 Compare October 23, 2026 15:14
…hive

Every page has a Slovak counterpart under docs/sk/ with a language menu,
hreflang links and Slovak structured data; English stays the default.
The version menu links the latest docs at the root and the 5.x archive,
which is the 5.0.0 README with its known mistakes listed.
check-locales.py fails the docs check when a page exists in one language.

Closes #76
@tomaj
tomaj force-pushed the docs/slovak-versioned branch from dd37258 to a548947 Compare October 23, 2026 15:50
@tomaj
tomaj merged commit c00c0de into master Oct 23, 2026
27 checks passed
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.

Slovak documentation translation and versioned docs (5.x / 6.x)

2 participants