docs-i18n 0.8.1 → 0.8.3

package/template/content/docs-i18n/en/architecture.md

@@ -0,0 +1,335 @@
+---
+title: Architecture
+description: How docs-i18n works internally -- the translation pipeline, AST parsing, caching, and chunking strategies.
+---
+
+# Architecture
+
+This document explains how docs-i18n works internally. Understanding the pipeline helps you tune configuration, debug issues, and contribute to the project.
+
+## System Overview
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                        docs-i18n ecosystem                      │
+│                                                                 │
+│  ┌──────────┐    ┌───────────┐    ┌──────────┐    ┌─────────┐  │
+│  │ CLI      │    │ Admin     │    │ Template │    │ Runtime │  │
+│  │          │    │ Dashboard │    │ (Site)   │    │ (D1)    │  │
+│  │ translate│    │ (pre-     │    │ TanStack │    │ CF      │  │
+│  │ rescan   │    │  built)   │    │ Start    │    │ Workers │  │
+│  │ assemble │    │           │    │          │    │         │  │
+│  │ status   │    │ Web UI    │    │ SSR docs │    │ Edge    │  │
+│  └────┬─────┘    └─────┬─────┘    └────┬─────┘    └────┬────┘  │
+│       │                │               │               │        │
+│       └────────┬───────┴───────┬───────┘               │        │
+│                │               │                       │        │
+│         ┌──────▼──────┐  ┌─────▼──────┐          ┌─────▼─────┐  │
+│         │ SQLite      │  │ Content    │          │ D1        │  │
+│         │ .cache/     │  │ content/   │          │ (cloud)   │  │
+│         │ translations│  │ {project}/ │          │           │  │
+│         │ .db         │  │ {version}/ │          │ translate │  │
+│         └─────────────┘  └────────────┘          │ ions      │  │
+│                                                  └───────────┘  │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+## Monorepo Structure
+
+```
+docs-i18n/
+  packages/
+    core/          ← Published as "docs-i18n" on npm
+    │  src/
+    │    cli.ts         CLI entry point
+    │    core/          Parser, cache, assembler, translator
+    │    commands/      translate, rescan, assemble, status, upload
+    │  dist/            Built output
+    │
+    admin/         ← Pre-built admin dashboard
+    │  app/             TanStack Start React app
+    │  server/          Server functions (status, jobs, models)
+    │  dist/            Pre-built (zero-install runtime)
+    │  serve.mjs        Node.js HTTP adapter
+    │
+    template/      ← Docs site template (built per-project)
+       app/             TanStack Start React app
+       content/         Demo content + docs-i18n's own docs
+```
+
+## Translation Pipeline
+
+```
+Source .md/.mdx files (English)
+    │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  1. Normalize                                     │
+│  Ensure JSX tags (<AppOnly> etc.) are separated  │
+│  by blank lines for correct AST parsing          │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  2. Parse (remark AST)                            │
+│  .md/.mdx → flat list of typed nodes             │
+│  heading | paragraph | list | code | html | ...  │
+│  Each node: { type, rawText, needsTranslation }  │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  3. Hash (MD5)                                    │
+│  "## Installation" → "a1b2c3d4..."               │
+│  Same content = same key = deduplicated           │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  4. Smart Chunking                                │
+│  Group nodes into chunks fitting LLM context     │
+│  Input budget + output budget + language mult.   │
+│  CJK: 2.5x │ Cyrillic: 2.0x │ Chinese: 1.5x    │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  5. LLM Translation                               │
+│  Send: { nodes: [{ key, type, text }] }          │
+│  Recv: { "a1b2c3": "翻译结果" }                   │
+│  JSON repair + key recovery + retry + rotation   │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  6. Cache (SQLite)                                │
+│  INSERT INTO translations (lang, key, value)     │
+│  WAL mode │ concurrent-safe │ instant writes     │
+└──────────────────┬───────────────────────────────┘
+                   │
+    ▼
+┌──────────────────────────────────────────────────┐
+│  7. Assemble                                      │
+│  English source + cached translations            │
+│  → translated .md/.mdx files                     │
+│  Missing translations → fallback to English      │
+└──────────────────────────────────────────────────┘
+```
+
+## Content Structure Convention
+
+```
+your-project/
+  content/                          ← English source (no /en/ subdir)
+    {project}/{version}/            ← e.g. query/v5/ or nextjs/latest/
+      overview.md
+      guides/routing.md
+      ...
+
+  .cache/
+    translations.db                 ← SQLite cache (all languages)
+    content/{version}/{lang}/       ← assembled translations
+      overview.md
+      guides/routing.md
+
+  docs-i18n.config.ts               ← translation config
+  site.config.ts                    ← site template config
+```
+
+The site template resolves content as:
+```
+Request: /zh-hans/query/v5/docs/overview
+                   │     │        │
+                   │     │        └─ slug
+                   │     └─ version
+                   └─ project
+
+  English: content/query/v5/overview.md              ← direct read
+  zh-hans: .cache/ → translations.db → assemble()   ← from cache
+  Fallback: English source (isFallback: true)
+```
+
+## Step 1: Normalization
+
+The `normalize()` function (`src/core/normalize.ts`) preprocesses MDX content to ensure that JSX tags like `<AppOnly>`, `<PagesOnly>`, `<details>`, and `<div>` are separated from surrounding content by blank lines. This ensures remark parses them as independent HTML nodes rather than merging them with adjacent text.
+
+For example, this input:
+
+```
+<AppOnly>
+Some text here
+</AppOnly>
+```
+
+Becomes:
+
+```
+<AppOnly>
+
+Some text here
+
+</AppOnly>
+```
+
+## Step 2: AST Parsing
+
+The `parseMdx()` function (`src/core/parser.ts`) uses remark to parse markdown into a flat list of `ParsedNode` objects. Each node has:
+
+- `type` -- The AST node type: `paragraph`, `heading`, `list`, `blockquote`, `code`, `html`, `thematicBreak`, or `frontmatter`.
+- `rawText` -- The raw text content from the normalized source.
+- `needsTranslation` -- Whether this node contains human-readable text.
+- `md5` -- MD5 hash of the raw text (only for translatable nodes).
+- `startOffset` / `endOffset` -- Character offsets in the normalized content.
+
+**Translatable node types:** `paragraph`, `heading`, `list`, `blockquote`, and `html` nodes that contain non-tag text (e.g., `<summary>Examples</summary>`).
+
+**Non-translatable:** `code` blocks, `thematicBreak`, and pure HTML/JSX tags (self-closing tags like `<Check size={18} />`, opening/closing tags like `<AppOnly></AppOnly>`).
+
+**Frontmatter handling:** If the content starts with `---`, the parser detects YAML frontmatter and emits it as a single `frontmatter` node spanning from the opening `---` to the closing `---`. The frontmatter module (`src/core/frontmatter.ts`) then extracts only the configured translatable fields (e.g., `title`, `description`) using the `yaml` library, sends them to the LLM as plain text, and reconstructs the YAML with translated values while preserving all other fields and formatting.
+
+## Step 3: MD5 Hashing
+
+Each translatable node's raw text is hashed with MD5 to produce a stable key. This key is used for:
+
+- **Deduplication** -- identical content appearing in multiple files (or even multiple projects) shares a single translation.
+- **Incremental updates** -- when source content changes, only the nodes with new MD5 hashes need translation. Unchanged nodes reuse their cached translations.
+- **Heading differentiation** -- heading nodes include their level markers (`##`, `###`) in the hash, so "## Installation" and "### Installation" produce different keys.
+
+## Step 4: Smart Chunking
+
+The translate command groups untranslated nodes into chunks that fit within the LLM's context window. The chunking algorithm (`src/commands/translate.ts`) accounts for:
+
+- **Input budget** -- system prompt tokens + source text tokens. Estimated at `text.length / 4 + 80` tokens per node (accounting for JSON structure overhead).
+- **Output budget** -- translated text tokens. Scaled by a per-language multiplier since different languages use tokens differently:
+
+| Language | Multiplier | Reason |
+| --- | --- | --- |
+| Japanese, Korean, Hindi, Thai | 2.5x | CJK/Indic tokenization |
+| Russian, Arabic, Ukrainian, Hebrew | 2.0x | Cyrillic/Arabic scripts |
+| Chinese (Simplified/Traditional) | 1.5x | CJK but more concise |
+| German, French, Portuguese | 1.3x | Slightly longer than English |
+| Spanish, Vietnamese | 1.2x | Close to English length |
+| Other languages | 2.0x | Safe default |
+
+- **System prompt overhead** -- approximately 700 tokens for the translation prompt.
+- **JSON structure overhead** -- approximately 80 tokens per key for JSON schema properties.
+- **Safety margin** -- 85% of input budget and 75% of output budget are used to leave room for estimation errors.
+
+When a chunk reaches its budget, a new chunk is started. This prevents context window overflow and output truncation.
+
+## Step 5: LLM Translation
+
+The translator (`src/core/translator.ts`) uses structured JSON mode for translations:
+
+**Input format:** A JSON object with a `nodes` array. Each node has a `key` (MD5), `type` (heading/paragraph/list/etc.), and `text` (content to translate).
+
+```json
+{
+  "nodes": [
+    { "key": "a1b2c3...", "type": "heading", "text": "## Installation" },
+    { "key": "d4e5f6...", "type": "paragraph", "text": "Run the following command:" }
+  ]
+}
+```
+
+**Output format:** A flat JSON object mapping each key to its translation.
+
+```json
+{
+  "a1b2c3...": "## \u5b89\u88c5",
+  "d4e5f6...": "\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\uff1a"
+}
+```
+
+**Robustness features:**
+
+- **JSON repair** -- Handles common LLM JSON errors: unescaped newlines in strings, trailing commas, missing closing braces.
+- **Thinking block stripping** -- Removes `<think>...</think>` blocks from reasoning models.
+- **Unwrapping** -- If the model wraps output in `{"nodes": {...}}` or `{"translations": {...}}`, it is automatically unwrapped.
+- **Key recovery** -- If the model corrupts an MD5 key (e.g., truncates it), the translator attempts fuzzy matching to recover the translation (up to 3 character differences).
+- **Garbage detection** -- If more than 50% of translation values are identical, the model output is rejected.
+- **Retry with backoff** -- Retries on 429 (rate limit), 503, 405, timeout, and connection errors. Uses exponential backoff starting at 2 seconds.
+- **Model rotation** -- Supports a list of models to rotate through. Dead models (400/404 errors) are skipped. Rate-limited models (429) are deprioritized.
+- **Truncation detection** -- If `finish_reason` is `'length'`, the output was truncated and the request is retried.
+
+**Frontmatter translation:**
+
+Frontmatter nodes are handled specially. Instead of sending the entire YAML block, the translator extracts individual translatable fields (e.g., `title`, `description`) and sends them as plain `paragraph` type nodes with virtual keys like `fm:<md5>:title`. After translation, the fields are reassembled into the original YAML structure using `reconstructFrontmatter()`.
+
+## Step 6: SQLite Cache
+
+The `TranslationCache` class (`src/core/cache.ts`) manages all persistent state in a single SQLite database at `<cacheDir>/translations.db`.
+
+**Schema:**
+
+```sql
+-- EN source texts (deduplicated by MD5)
+CREATE TABLE sources (
+  key   TEXT PRIMARY KEY NOT NULL,  -- MD5 hash
+  text  TEXT NOT NULL,              -- original English text
+  type  TEXT NOT NULL DEFAULT 'paragraph'
+);
+
+-- Which files use each source node
+CREATE TABLE source_files (
+  key     TEXT    NOT NULL,  -- MD5 hash
+  file    TEXT    NOT NULL,  -- relative file path
+  line    INTEGER NOT NULL,  -- line number
+  version TEXT    NOT NULL DEFAULT 'latest',
+  PRIMARY KEY (version, key, file, line)
+);
+
+-- Translated texts per language
+CREATE TABLE translations (
+  lang       TEXT    NOT NULL,  -- language code
+  key        TEXT    NOT NULL,  -- MD5 hash
+  value      TEXT    NOT NULL,  -- translated text
+  created_at INTEGER NOT NULL DEFAULT (unixepoch()),
+  updated_at INTEGER NOT NULL DEFAULT (unixepoch()),
+  PRIMARY KEY (lang, key)
+);
+```
+
+**Performance configuration:**
+
+- **WAL mode** -- Write-Ahead Logging enables concurrent readers with a single writer. No locking issues during parallel translation and assembly.
+- **busy_timeout = 5000** -- Wait up to 5 seconds for a lock before failing.
+- **synchronous = NORMAL** -- Balanced between safety and performance.
+- **WITHOUT ROWID** -- Tables use the primary key directly, avoiding an extra rowid column.
+- **Immediate writes** -- All `set()` calls write directly to disk. No explicit save step needed.
+
+**Key operations:**
+
+- `get(lang, md5)` -- Look up a cached translation.
+- `set(lang, md5, translation)` -- Store or update a translation (upsert).
+- `untranslatedKeys(lang, version)` -- Find all source keys that have no translation for a given language.
+- `fileCoverage(version, lang)` -- Get per-file translation coverage (used by the admin dashboard).
+- `prune(lang, usedMd5s)` -- Remove translations whose keys are no longer referenced.
+- `exportJsonl(lang, outputPath)` / `importJsonl(lang, inputPath)` -- Export/import translations in JSONL format for backup or migration.
+
+**SQLite compatibility:**
+
+The `openDatabase()` function (`src/core/sqlite.ts`) automatically detects the runtime environment. Under Bun, it uses `bun:sqlite`. Under Node.js, it uses `better-sqlite3`. Both expose the same interface.
+
+## Step 7: Assembly
+
+The `assemble()` function (`src/core/assembler.ts`) produces a translated file from English source content and cached translations:
+
+1. Normalizes the source content.
+2. Parses it into AST nodes.
+3. For each node:
+   - **Non-translatable nodes** (code blocks, HTML tags) are kept as-is.
+   - **Translatable nodes with a cached translation** are replaced with the cached value.
+   - **Translatable nodes without a cache hit** are either wrapped in `<!-- NEEDS_TRANSLATION -->` markers (for the legacy whole-file translation mode) or fall back to the original English text (for assembled output files).
+4. Preserves all whitespace and newlines between nodes.
+
+The `AssembleResult` includes statistics: `cachedCount`, `uncachedCount`, `totalTranslatable`, and whether all nodes were cached (`allCached`).
+
+## Validation
+
+The `validate()` function (`src/core/validator.ts`) compares LLM output against the translation cache to detect and correct modifications to already-cached translations. It uses two alignment strategies:
+
+- **Fast path** -- When the number of translatable nodes in the source and output match, nodes are aligned by index.
+- **Anchor-based alignment** -- When node counts differ (the LLM merged or split paragraphs), cached translations serve as anchor points. The validator finds exact matches between output text and cached translations, then aligns nodes between anchors by type matching.
+
+Cached translations always override LLM modifications, ensuring translation consistency across runs.

package/template/content/docs-i18n/en/cli.md

@@ -271,6 +271,15 @@ For non-English languages, the site automatically loads translations from the `.
 
 ### Full translation pipeline
 
+```
+rescan ──→ status ──→ translate ──→ assemble ──→ site dev
+  │           │           │            │            │
+  ▼           ▼           ▼            ▼            ▼
+ Index     Progress    Send to     EN + cache    Serve
+ source     bars       LLM, cache   → output    multilingual
+ files                 results      files        docs site
+```
+
 ```bash
 # 1. Scan source files
 docs-i18n rescan
@@ -281,8 +290,11 @@ docs-i18n status
 # 3. Translate
 docs-i18n translate --lang zh-hans
 
-# 4. Assemble output
+# 4. Assemble output (optional — site does this at runtime)
 docs-i18n assemble --lang zh-hans
+
+# 5. Start docs site
+docs-i18n site
 ```
 
 ### Translate a single file for review