Skip to content

Commit bdc3324

Browse files
committed
[DOCS, FIX] ko translation - phase 3, fix termynal.js comments render
1 parent 5af2f73 commit bdc3324

11 files changed

Lines changed: 3641 additions & 22 deletions

docs/en/contributing/translation-guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ The user-facing companion to this policy is the
1818
lists each locale's actual completeness and how MkDocs renders pages
1919
that haven't been translated yet (TL;DR: they fall back to English).
2020

21+
The repository-root `CHANGELOG.md` also remains in English as the
22+
canonical release history. If a locale exposes a `changelog.md` page,
23+
that page should link to or include the canonical English changelog
24+
rather than maintain a separate translated changelog unless project
25+
policy changes later.
26+
2127
When you contribute a translation, also update the status page's table
2228
so users can tell what's available without guessing from the language
2329
switcher.
@@ -213,6 +219,14 @@ The script will create a Pull Request with the translations. Review the PR:
213219
3. Ensure code examples remain unchanged
214220
4. Check for language-specific issues
215221

222+
### Changelog policy
223+
224+
- Keep the repository-root `CHANGELOG.md` in English.
225+
- Do not open translation PRs whose goal is to rewrite release history
226+
into another language inside the root changelog.
227+
- If a locale needs a changelog page, treat `docs/<locale>/changelog.md`
228+
as a wrapper or entry point for the canonical English changelog.
229+
216230
### 4. Approve and Merge (for maintainers)
217231

218232
Once the translation is verified:

docs/en/reference/translation-status.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ The English files live under [`docs/en/`](https://github.com/bnbong/FastAPI-fast
1919
Every other locale (`docs/ko/`, `docs/ja/`, ...) is a translation
2020
target.
2121

22+
The repository-root `CHANGELOG.md` is part of that English source of
23+
truth. Locale-specific `changelog.md` pages may exist as wrappers or
24+
entry points, but they intentionally reuse the canonical English
25+
release history instead of maintaining translated copies.
26+
2227
## Per-locale completeness
2328

2429
The numbers below count Markdown pages in each locale's directory tree
@@ -29,14 +34,14 @@ next section explains).
2934
| Locale | Status | Markdown pages | Notes |
3035
|---|---|---:|---|
3136
| 🇬🇧 English (`en`) | ✅ Source of truth | 26 / 26 | Authoritative. |
32-
| 🇰🇷 Korean (`ko`) | 🟡 Partial | 19 / 26 | `index.md`, `changelog.md`, `reference/translation-status.md`, all 7 user-guide pages, and all 9 tutorial pages. Other pages (contributing, broader reference) fall back to English. |
37+
| 🇰🇷 Korean (`ko`) | ✅ Complete | 26 / 26 | All locale pages are present. Phase 1: top-level + core user-guide; Phase 2: remaining user-guide + all tutorials; Phase 3: contributing + reference. `docs/ko/changelog.md` intentionally reuses the canonical English `CHANGELOG.md`. |
3338
| 🇯🇵 Japanese (`ja`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
3439
| 🇨🇳 Chinese (`zh`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
3540
| 🇪🇸 Spanish (`es`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
3641
| 🇫🇷 French (`fr`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
3742
| 🇩🇪 German (`de`) | 🔴 Skeleton | 0 / 26 | Build target only. Every page falls back to English. |
3843

39-
*Snapshot verified 2026-05-07; ko row recounted for the current branch after Phase 2 (user-guide + tutorial) translations landed.* These counts are maintained by hand;
44+
*Snapshot verified 2026-05-07; ko row recounted for the current branch after Phase 3 (contributing + reference) landed. Korean now has all locale pages present, while `docs/ko/changelog.md` intentionally points to the canonical English changelog.* These counts are maintained by hand;
4045
to recount the current state from the repo root, run:
4146

4247
```console
@@ -91,9 +96,9 @@ underlying content actually is.
9196
The current rollout is **one tracking issue per locale**, with the work
9297
broken into **phases** — for example `ko` is being landed across
9398
Phase 1 (top-level + core user-guide), Phase 2 (remaining user-guide +
94-
all tutorials), Phase 3 (contributing + reference + changelog). Each
95-
phase ships as its own PR so reviewers can sign off on a coherent slice
96-
without waiting for the entire locale to be finished.
99+
all tutorials), Phase 3 (contributing + reference). Each phase ships
100+
as its own PR so reviewers can sign off on a coherent slice without
101+
waiting for the entire locale to be finished.
97102

98103
If you'd like to contribute:
99104

@@ -113,7 +118,9 @@ If you'd like to contribute:
113118
4. Open the PR adding files under `docs/<locale>/<same path>`. Keep
114119
filenames identical to the English source so MkDocs picks them up
115120
automatically.
116-
5. Update this page's table to reflect the new completeness count
121+
5. Treat localized changelog pages as wrappers around the canonical
122+
English `CHANGELOG.md` unless project policy explicitly changes.
123+
6. Update this page's table to reflect the new completeness count
117124
(use the recount snippet at the top of this page) and bump the
118125
"Snapshot verified" date so reviewers can see when it was last
119126
reconciled. Note in the "Notes" column which phase has landed if

docs/js/custom.js

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,23 @@ function setupTermynal() {
6767
saveBuffer();
6868
const promptStart = line.indexOf(promptLiteralStart);
6969
if (promptStart === -1) {
70-
console.error("Custom prompt found but no end delimiter", line)
70+
const value = "💬 " + line.replace(customPromptLiteralStart, "").trimEnd();
71+
useLines.push({
72+
value: value,
73+
class: "termynal-comment",
74+
delay: 0
75+
});
76+
} else {
77+
const prompt = line
78+
.slice(0, promptStart)
79+
.replace(customPromptLiteralStart, "");
80+
const value = line.slice(promptStart + promptLiteralStart.length);
81+
useLines.push({
82+
type: "input",
83+
value: value,
84+
prompt: prompt
85+
});
7186
}
72-
const prompt = line.slice(0, promptStart).replace(customPromptLiteralStart, "")
73-
let value = line.slice(promptStart + promptLiteralStart.length);
74-
useLines.push({
75-
type: "input",
76-
value: value,
77-
prompt: prompt
78-
});
7987
} else {
8088
buffer.push(line);
8189
}

0 commit comments

Comments
 (0)