Skip to content

docs: add Russian overview documentation#601

Open
DrMaks22 wants to merge 3 commits intojamiepine:mainfrom
DrMaks22:codex/ru-docs-pr
Open

docs: add Russian overview documentation#601
DrMaks22 wants to merge 3 commits intojamiepine:mainfrom
DrMaks22:codex/ru-docs-pr

Conversation

@DrMaks22
Copy link
Copy Markdown

@DrMaks22 DrMaks22 commented May 2, 2026

Summary

Adds a Russian-authored documentation section for the overview docs and links it from the main documentation navigation.

Scope

This PR is intentionally limited to authored docs content:

  • adds a new docs/content/docs/ru section
  • introduces Russian overview navigation metadata
  • translates the overview documentation pages into Russian
  • links the new Russian section from the root docs navigation

Included pages

  • introduction
  • installation
  • gpu acceleration
  • docker
  • quick start
  • creating voice profiles
  • dictation
  • captures
  • recording and transcription
  • voice cloning
  • preset voices
  • MCP server
  • voice personalities
  • generating speech
  • stories editor
  • generation history
  • building stories
  • remote mode
  • troubleshooting

Testing

  • ./node_modules/.bin/fumadocs-mdx
  • git diff --check

Related PRs

  • #599 adds the Russian desktop app locale
  • #600 adds the Russian landing-site route layer and translated marketing pages

Non-goals

  • no desktop app localization changes
  • no landing/site localization changes
  • no generated API reference localization
  • no docs app infrastructure changes

Notes

  • This PR focuses on the authored overview docs only, which keeps the review surface manageable.
  • The docs app still has an unrelated next/font/google build dependency; this PR does not change that infrastructure path.

Summary by CodeRabbit

  • Documentation
    • Added a complete Russian documentation section (many overview pages: introduction, installation, quick start, dictation, Captures, voice profiles, voice cloning, generating speech, preset voices, Stories Editor, generation history, recording/transcription, GPU acceleration, Docker, Remote Mode, MCP server, voice personalities, troubleshooting, and how‑tos).
    • Updated docs metadata/navigation to include the new Russian locale.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c61a8ffe-ca04-455a-9c09-a7c4bff8e1e3

📥 Commits

Reviewing files that changed from the base of the PR and between 6ea20c4 and dd36c9b.

📒 Files selected for processing (3)
  • docs/content/docs/ru/overview/dictation.mdx
  • docs/content/docs/ru/overview/gpu-acceleration.mdx
  • docs/content/docs/ru/overview/preset-voices.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/content/docs/ru/overview/preset-voices.mdx
  • docs/content/docs/ru/overview/dictation.mdx

📝 Walkthrough

Walkthrough

Adds a Russian (ru) documentation section: registers ru in top-level docs metadata and adds a complete set of Russian MDX pages and metadata under docs/content/docs/ru, covering overview, installation, features, guides, MCP, GPU, Stories Editor, troubleshooting, and navigation metadata.

Changes

Russian documentation localization

Layer / File(s) Summary
Docs Index / Registration
docs/content/docs/meta.json
Adds "ru" to the top-level pages array to register the Russian docs section.
Section Root & Entry
docs/content/docs/ru/index.mdx, docs/content/docs/ru/meta.json
Adds Russian docs homepage (index.mdx) and top-level meta.json (title: "Документация на русском", pages: ["overview"]).
Overview TOC / Navigation
docs/content/docs/ru/overview/meta.json
Adds overview section metadata (title: "Обзор", defaultOpen: true, ordered pages list for the overview).
Overview pages — primary content
docs/content/docs/ru/overview/introduction.mdx, .../installation.mdx, .../gpu-acceleration.mdx, .../docker.mdx, .../quick-start.mdx, .../creating-voice-profiles.mdx, .../dictation.mdx, .../captures.mdx, .../recording-transcription.mdx, .../voice-cloning.mdx, .../preset-voices.mdx, .../generating-speech.mdx, .../generation-history.mdx, .../mcp-server.mdx, .../voice-personalities.mdx, .../stories-editor.mdx, .../building-stories.mdx, .../remote-mode.mdx, .../troubleshooting.mdx
Adds ~20 Russian MDX pages that implement the overview content, feature guides, operational guides, and troubleshooting material; each page includes frontmatter and structured sections per topic.
Top-level locale pages
docs/content/docs/ru/*.mdx
Adds top-level Russian landing/index content describing scope, translated page list, and roadmap items (what’s already translated and next steps).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 Я в норку прыг — страницы укрыл,

Русский раздел в документах открыл.
Голосов путь, советы и шаги,
Пусть читатель найдёт ответы свои.
Хвост трубит радостно — локаль готова к дню!

🚥 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 'docs: add Russian overview documentation' is clear and directly related to the main change: adding a complete Russian documentation section for the overview docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 8

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/content/docs/ru/overview/preset-voices.mdx (1)

213-226: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix RU navigation links in “Что дальше” (missing /ru prefix).

In the last cards section, Lines 219 and 222 point to non-RU paths:

  • /overview/generating-speech
  • /overview/building-stories

On the Russian docs site these should be under /ru/overview/... to avoid broken/mixed-language navigation.

🛠️ Proposed fix
- <Card title="Генерация речи" href="/overview/generating-speech">
+ <Card title="Генерация речи" href="/ru/overview/generating-speech">

- <Card title="Stories" href="/overview/building-stories">
+ <Card title="Stories" href="/ru/overview/building-stories">
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/content/docs/ru/overview/preset-voices.mdx` around lines 213 - 226,
Update the hrefs inside the Cards section so the Russian navigation uses the /ru
prefix: in the Card elements titled "Генерация речи" and "Stories" (the Card
components with href="/overview/generating-speech" and
href="/overview/building-stories"), change those href values to
"/ru/overview/generating-speech" and "/ru/overview/building-stories"
respectively so all links in the Cards block remain on the Russian docs site.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/docs/ru/overview/captures.mdx`:
- Around line 165-167: Update the RU documentation link so the "Remote Mode"
anchor points to the Russian overview path instead of the English one: replace
the href `/overview/remote-mode` with `/ru/overview/remote-mode` in the
captures.mdx content where the sentence "см. раздел [Remote
Mode](/overview/remote-mode)" appears so the link targets the RU page (look for
the "Remote Mode" link text in that file).
- Around line 170-180: The "Создание голосовых профилей" Card component has an
incorrect href missing the /ru prefix; update the Card with title "Создание
голосовых профилей" (the Card element in the <Cards> block) to use
href="/ru/overview/creating-voice-profiles" so the Russian docs route is
consistent with the other RU links.

In `@docs/content/docs/ru/overview/dictation.mdx`:
- Around line 162-169: In the Windows paragraph, update the sentence containing
"Правостороннее сочетание `Ctrl+Shift` выбрано в том числе для обхода конфликтов
с AltGr." by adding commas around the parenthetical phrase "в том числе" so it
reads "Правостороннее сочетание `Ctrl+Shift` выбрано, в том числе, для обхода
конфликтов с AltGr."; locate this exact sentence in the doc and insert the two
commas without changing surrounding wording or code formatting.

In `@docs/content/docs/ru/overview/gpu-acceleration.mdx`:
- Around line 267-268: The Card component with title "Troubleshooting" currently
links to the English route; update its href attribute (the Card with title
"Troubleshooting") to point to the Russian locale path
/ru/overview/troubleshooting so the RU page links to the RU troubleshooting page
for locale consistency.

In `@docs/content/docs/ru/overview/preset-voices.mdx`:
- Around line 8-12: Replace the phrase "по собственному аудио" with the
hyphenated form "по-собственному аудио" in the sentence that begins "Вместо
клонирования по собственному аудио вы выбираете голос..." so the wording matches
LanguageTool's suggested hyphenation; ensure only the hyphenation is changed and
punctuation/spacing for the surrounding sentence remains unchanged.

In `@docs/content/docs/ru/overview/quick-start.mdx`:
- Around line 132-133: The Card with title "Продвинутая работа с клонированием
голоса" incorrectly links to "/ru/overview/introduction"; update the href on
that Card element to point to the correct voice-cloning follow-up page (replace
href="/ru/overview/introduction" with the appropriate voice-cloning slug, e.g.
"/ru/overview/voice-cloning" or the actual canonical path used in the docs) so
the card navigates to the advanced voice-cloning article rather than the
introduction.

In `@docs/content/docs/ru/overview/voice-cloning.mdx`:
- Around line 130-137: Update the three Card hrefs so they use RU-prefixed
locale paths to preserve Russian navigation continuity: change the href in the
Card with title "Создание голосовых профилей" from
"/overview/creating-voice-profiles" to "/ru/overview/creating-voice-profiles",
change the href in the Card with title "Готовые голоса" from
"/ru/overview/preset-voices" (verify it's already RU; leave if correct), and
change the href in the Card with title "Генерация речи" from
"/overview/generating-speech" to "/ru/overview/generating-speech" so all cards
consistently point to /ru/overview/… .

In `@docs/content/docs/ru/overview/voice-personalities.mdx`:
- Around line 160-172: The Card with title "Создание голосовых профилей" uses an
incorrect href ("/overview/creating-voice-profiles") for the RU page; update
that Card's href prop to include the RU path
("/ru/overview/creating-voice-profiles") so the Cards component's link points to
the localized route.

---

Outside diff comments:
In `@docs/content/docs/ru/overview/preset-voices.mdx`:
- Around line 213-226: Update the hrefs inside the Cards section so the Russian
navigation uses the /ru prefix: in the Card elements titled "Генерация речи" and
"Stories" (the Card components with href="/overview/generating-speech" and
href="/overview/building-stories"), change those href values to
"/ru/overview/generating-speech" and "/ru/overview/building-stories"
respectively so all links in the Cards block remain on the Russian docs site.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a58e7c42-f9ab-4043-955a-601dc4313d87

📥 Commits

Reviewing files that changed from the base of the PR and between b35b909 and 12d3213.

📒 Files selected for processing (23)
  • docs/content/docs/meta.json
  • docs/content/docs/ru/index.mdx
  • docs/content/docs/ru/meta.json
  • docs/content/docs/ru/overview/building-stories.mdx
  • docs/content/docs/ru/overview/captures.mdx
  • docs/content/docs/ru/overview/creating-voice-profiles.mdx
  • docs/content/docs/ru/overview/dictation.mdx
  • docs/content/docs/ru/overview/docker.mdx
  • docs/content/docs/ru/overview/generating-speech.mdx
  • docs/content/docs/ru/overview/generation-history.mdx
  • docs/content/docs/ru/overview/gpu-acceleration.mdx
  • docs/content/docs/ru/overview/installation.mdx
  • docs/content/docs/ru/overview/introduction.mdx
  • docs/content/docs/ru/overview/mcp-server.mdx
  • docs/content/docs/ru/overview/meta.json
  • docs/content/docs/ru/overview/preset-voices.mdx
  • docs/content/docs/ru/overview/quick-start.mdx
  • docs/content/docs/ru/overview/recording-transcription.mdx
  • docs/content/docs/ru/overview/remote-mode.mdx
  • docs/content/docs/ru/overview/stories-editor.mdx
  • docs/content/docs/ru/overview/troubleshooting.mdx
  • docs/content/docs/ru/overview/voice-cloning.mdx
  • docs/content/docs/ru/overview/voice-personalities.mdx

Comment thread docs/content/docs/ru/overview/captures.mdx
Comment thread docs/content/docs/ru/overview/captures.mdx
Comment thread docs/content/docs/ru/overview/dictation.mdx
Comment thread docs/content/docs/ru/overview/gpu-acceleration.mdx Outdated
Comment on lines +8 to +12
Некоторые движки Voicebox поставляются с уже подготовленным набором голосов.
Вместо клонирования по собственному аудио вы выбираете голос из каталога, и
модель озвучивает текст именно в этой манере. Никакой записи, загрузки образца
или обучения под конкретного спикера не требуется.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Hyphenate “по-собственному” (LanguageTool).

At Line 9 the phrase is currently “по собственному аудио”. LanguageTool suggests the correct hyphenation: “по-собственному”.

🛠️ Proposed fix
- Вместо клонирования по собственному аудио вы выбираете голос из каталога, и
+ Вместо клонирования по-собственному аудио вы выбираете голос из каталога, и
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Некоторые движки Voicebox поставляются с уже подготовленным набором голосов.
Вместо клонирования по собственному аудио вы выбираете голос из каталога, и
модель озвучивает текст именно в этой манере. Никакой записи, загрузки образца
или обучения под конкретного спикера не требуется.
Некоторые движки Voicebox поставляются с уже подготовленным набором голосов.
Вместо клонирования по-собственному аудио вы выбираете голос из каталога, и
модель озвучивает текст именно в этой манере. Никакой записи, загрузки образца
или обучения под конкретного спикера не требуется.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~9-~9: Слово пишется через дефис: «по-собственному».
Context: ...ым набором голосов. Вместо клонирования по собственному аудио вы выбираете голос из каталога, и...

(Pravopisanie_po-prezhnemu)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/content/docs/ru/overview/preset-voices.mdx` around lines 8 - 12, Replace
the phrase "по собственному аудио" with the hyphenated form "по-собственному
аудио" in the sentence that begins "Вместо клонирования по собственному аудио вы
выбираете голос..." so the wording matches LanguageTool's suggested hyphenation;
ensure only the hyphenation is changed and punctuation/spacing for the
surrounding sentence remains unchanged.

Comment on lines +132 to +133
<Card title="Продвинутая работа с клонированием голоса" href="/ru/overview/introduction">
Разобраться в движках, моделях и сильных сторонах Voicebox
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix mismatched card link target for voice-cloning follow-up.

At Line 132, the card title is about advanced voice cloning, but the href points to introduction. This is likely a wrong destination for users.

Suggested fix
-  <Card title="Продвинутая работа с клонированием голоса" href="/ru/overview/introduction">
+  <Card title="Продвинутая работа с клонированием голоса" href="/ru/overview/voice-cloning">
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Card title="Продвинутая работа с клонированием голоса" href="/ru/overview/introduction">
Разобраться в движках, моделях и сильных сторонах Voicebox
<Card title="Продвинутая работа с клонированием голоса" href="/ru/overview/voice-cloning">
Разобраться в движках, моделях и сильных сторонах Voicebox
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/content/docs/ru/overview/quick-start.mdx` around lines 132 - 133, The
Card with title "Продвинутая работа с клонированием голоса" incorrectly links to
"/ru/overview/introduction"; update the href on that Card element to point to
the correct voice-cloning follow-up page (replace
href="/ru/overview/introduction" with the appropriate voice-cloning slug, e.g.
"/ru/overview/voice-cloning" or the actual canonical path used in the docs) so
the card navigates to the advanced voice-cloning article rather than the
introduction.

Comment thread docs/content/docs/ru/overview/voice-cloning.mdx Outdated
Comment thread docs/content/docs/ru/overview/voice-personalities.mdx
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/docs/ru/overview/gpu-acceleration.mdx`:
- Around line 91-97: The text "TORCH_CUDA_ARCH_LIST=...12.0+PTX" is misleading
because the ellipsis looks like a placeholder; update the wording to show a
clear, literal value or state that the list must include the 12.0+PTX entry —
e.g., replace the fragment with a phrase such as "TORCH_CUDA_ARCH_LIST includes
12.0+PTX (for example: TORCH_CUDA_ARCH_LIST=12.0+PTX)" or "ensure
TORCH_CUDA_ARCH_LIST contains 12.0+PTX" so readers know exactly what to set;
reference the exact symbol TORCH_CUDA_ARCH_LIST and the token 12.0+PTX when
editing.

In `@docs/content/docs/ru/overview/preset-voices.mdx`:
- Around line 15-19: The table entries for the TTS engines are out of sync with
backend constants: update the "Kokoro 82M" row to show 51 voices (not 50) and
update the "Qwen CustomVoice" row to show 10 supported synthesis languages (not
4); make the same corrections in the duplicate section around the other instance
(the second table block referenced in the comment). Locate the rows by the
unique engine names "Kokoro 82M" and "Qwen CustomVoice" in preset-voices.mdx and
change only the numeric values to match the backend.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d4dc87da-f037-432f-8ee0-d07c51b850b9

📥 Commits

Reviewing files that changed from the base of the PR and between 12d3213 and 6ea20c4.

📒 Files selected for processing (7)
  • docs/content/docs/ru/overview/captures.mdx
  • docs/content/docs/ru/overview/gpu-acceleration.mdx
  • docs/content/docs/ru/overview/preset-voices.mdx
  • docs/content/docs/ru/overview/quick-start.mdx
  • docs/content/docs/ru/overview/remote-mode.mdx
  • docs/content/docs/ru/overview/voice-cloning.mdx
  • docs/content/docs/ru/overview/voice-personalities.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/content/docs/ru/overview/captures.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/content/docs/ru/overview/remote-mode.mdx

Comment thread docs/content/docs/ru/overview/gpu-acceleration.mdx
Comment thread docs/content/docs/ru/overview/preset-voices.mdx
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