Skip to content

feat: localize steem-js core tutorials (index/read-api/broadcast) for all 7 locales (T7-3) - #54

Merged
ety001 merged 1 commit into
masterfrom
feat/t73-tutorials-steemjs-core
Nov 3, 2026
Merged

ety001 merged 1 commit into
masterfrom
feat/t73-tutorials-steemjs-core

Conversation

@ety001

@ety001 ety001 commented Nov 3, 2026

Copy link
Copy Markdown
Member

T7-3: Localize steem-js core tutorials for all 7 locales

Adds the tutorials-chapter steem-js trio — index (Getting Started), read-api (Reading Chain Data), broadcast (Broadcasting Operations) — translated into zh, ru, fr, de, it, es, ko: 21 new pages.

What's in this PR

  • 21 pages: docs/<lc>/tutorials/steem-js/{index,read-api,broadcast}.md for lc ∈ {zh, ru, fr, de, it, es, ko}.
  • config.mts: one new Tutorials sidebar group per locale, inserted between Guides and Services (zh=教程, ru=Обучающие материалы, fr=Tutoriels, de=Tutorials, it=Tutorial, es=Tutoriales, ko=튜토리얼), each carrying exactly the three steem-js items. Root/en untouched.

Guarantees

  • Code fences byte-identical to en: every page keeps the exact fence count of its en source (index: 21 blocks, read-api: 118, broadcast: 31) and every fenced line — including JS comments — is copied byte-for-byte. Verified by an independent reconciliation script over all 21 pages (PASS).
  • Terminology: each page follows the frozen <lc>-glossary.json baseline (first occurrence annotated 译法/표기 (English)); steem-js/@steemit/steem-js/JSON-RPC/STEEM/SBD/VESTS/condenser_api etc. left untranslated; method/parameter/field/config-key names kept in English.
  • En defects preserved as-is, e.g. the prematurely closed fence at index.md L254–255 in the Multiple API Instances section (stray }); outside the fence) — worth a follow-up fix in en upstream.
  • Explicit # headings are preserved in English per task spec (frontmatter title/description are translated).
  • En pages under docs/tutorials/ are untouched (git diff clean).

Link policy note

Links to the two sibling steem-js pages not yet localized on this branch (signed-calls.html) intentionally keep the en path (/tutorials/steem-js/signed-calls.html) instead of the locale prefix — VitePress fails the build on dead links, and the locale counterparts are landing in parallel PRs. Same pattern already used by docs/zh/api/index.md for not-yet-localized targets. Links to the three pages added here use /<lc>/tutorials/...; /api/ links use /<lc>/api/... (locale method pages are generated at build time by pnpm docs:gen).

Verification

  • Fence reconciliation script: all 21 pages PASS (counts + byte-identical fenced content).
  • All 21 frontmatters parse as valid YAML.
  • NODE_OPTIONS=--max-old-space-size=8192 pnpm build → exit 0 (build complete in ~308s; dist contains docs/<lc>/tutorials/steem-js/*.html for all locales).

ety001 added a commit that referenced this pull request Nov 3, 2026
… into 7 locales (T7-4)

Reapplied on top of T7-2: 14 locale pages (fence-identical to en) plus two
sidebar entries per locale Tutorials group. The transitional ignoreDeadLinks
option from T7-2 stays until the steem-js core pages (T7-3/#54) land.
ety001 added a commit that referenced this pull request Nov 3, 2026
…torials for all 7 locales (T7-4)

Reapplied on top of T7-2: 14 locale pages (fence-identical to en) plus two
sidebar entries per locale Tutorials group. The transitional ignoreDeadLinks
option from T7-2 stays until the steem-js core pages (T7-3/#54) land.
ety001 added a commit that referenced this pull request Nov 3, 2026
…ges (PR #54 review P1)

All 21 locale pages (7 locales x index/read-api/broadcast) carried English
headings. Translate 1264 heading lines into the page language following the
frozen glossary baselines (docs/.vitepress/<lc>-glossary.json); code
identifiers (steem-js, JSON-RPC, method signatures, WIF) stay verbatim.

Anchor preservation: fragment links referenced by in-page links keep their
original slugs via VitePress explicit anchors {#slug} — 9 anchors per locale
index (installation, browser-usage, configuration, json-rpc, api-routing,
usage-examples, typescript-support, error-handling, security-notes), covering
the 10 in-page links and the broadcast -> index #usage-examples cross-page
link per locale. Verified: fence reconciliation all 21 PASS (byte-identical
to en), NODE_OPTIONS=--max-old-space-size=8192 pnpm build exit 0, built-site
anchor audit: 1414/1414 fragment links resolve.
ety001 added a commit that referenced this pull request Nov 3, 2026
… into 7 locales (T7-4)

Reapplied on top of T7-2: 14 locale pages (fence-identical to en) plus two
sidebar entries per locale Tutorials group. The transitional ignoreDeadLinks
option from T7-2 stays until the steem-js core pages (T7-3/#54) land.
@ety001
ety001 force-pushed the feat/t73-tutorials-steemjs-core branch 2 times, most recently from 2365d34 to 63d165e Compare November 3, 2026 23:29
…t) into 7 locales (T7-3)

21 locale pages (fence-identical to en), headings translated with explicit
{#slug} anchors preserving all fragment-link targets (77 links machine-verified),
three steem-js sidebar entries per locale Tutorials group. Reapplied on top of
T7-2/T7-4 with the transitional ignoreDeadLinks option REMOVED - this commit
restores the strict dead-link check over the fully mirrored tree.
@ety001
ety001 merged commit f7f752d into master Nov 3, 2026
1 check passed
@ety001
ety001 deleted the feat/t73-tutorials-steemjs-core branch November 3, 2026 23:32
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