Skip to content

Локализация / Localization

Этот документ описывает структуру локализации проекта AB-Labz Library.

This document describes the localization structure of the AB-Labz Library project.


🌍 Доступные языки / Available Languages

  • English — основная локаль / primary locale: /
  • Русский (Russian) — русская версия / Russian version: /ru/

📁 Структура проекта / Project Structure

docs/
├── .vitepress/
│   ├── config.ts           # Основной конфиг / Main config
│   ├── config/
│   │   ├── ru.ts          # Конфигурация для русского / Russian config
│   │   └── en.ts          # Конфигурация для английского / English config
│   └── theme/
├── index.md                # 🇬🇧 Английский контент (root) / English content (root)
├── getting-started/
├── guide/
├── api/
├── interpretation/
├── statistics/
├── ru/                     # 🇷🇺 Русский контент / Russian content
│   ├── index.md
│   ├── getting-started/
│   ├── guide/
│   ├── api/
│   ├── interpretation/
│   └── statistics/
└── public/                 # Общие ресурсы / Shared resources
    ├── einst3.png
    └── favicon.svg

🔧 Как это работает / How It Works

Конфигурация / Configuration

Локализация настроена через опцию locales в config.ts:

typescript
export default defineConfig({
  locales: {
    root: enConfig,    // Английский как root
    ru: ruConfig       // Русский как /ru/
  }
})

Переключатель языков / Language Switcher

VitePress автоматически добавляет переключатель языков в правый верхний угол навигации.

VitePress automatically adds a language switcher to the top-right corner of the navigation.

Каждая локаль имеет свою независимую навигацию и sidebar, определенные в соответствующих конфигурационных файлах (ru.ts и en.ts).

Each locale has its own independent navigation and sidebar, defined in the respective config files (ru.ts and en.ts).


✍️ Добавление нового контента / Adding New Content

Для английской версии / For English version:

  1. Создайте файл в docs/ (root) / Create file in docs/ (root)
  2. Добавьте ссылку в docs/.vitepress/config/en.ts / Add link to docs/.vitepress/config/en.ts

Для русской версии / For Russian version:

  1. Создайте файл в docs/ru/ / Create file in docs/ru/
  2. Добавьте ссылку в docs/.vitepress/config/ru.ts / Add link to docs/.vitepress/config/ru.ts

🚀 Запуск проекта / Running the Project

bash
# Разработка / Development
npm run dev

# Сборка / Build
npm run build

# Предпросмотр сборки / Preview build
npm run serve

После запуска dev-сервера:

  • English version: /
  • Русская версия: /ru/

📝 Статус перевода / Translation Status

✅ Полностью переведено / Fully Translated

  • Главная страница / Home page
  • Быстрый старт / Quick Start
  • Терминология / Terminology
  • Каталог метрик / Metrics Catalog
  • Обзор API / API Overview
  • Таблица A/B теста / A/B Test Table
  • Зачем нужны A/B тесты / Why A/B Testing
  • Теория метрик / Metrics Theory

🔄 Требует перевода / Needs Translation

Остальные страницы в разделах:

  • guide/
  • api/
  • interpretation/
  • statistics/
  • theory/

💡 Рекомендации / Best Practices

  1. Синхронизация структуры / Structure Sync

    • Старайтесь поддерживать одинаковую структуру папок для обеих локалей
    • Try to maintain the same folder structure for both locales
  2. Переиспользование ресурсов / Resource Reuse

    • Изображения и файлы в public/ доступны для всех локалей
    • Images and files in public/ are available to all locales
  3. Независимая навигация / Independent Navigation

    • Каждая локаль может иметь свою уникальную навигацию
    • Each locale can have its own unique navigation
  4. SEO

    • VitePress автоматически добавляет правильные lang атрибуты
    • VitePress automatically adds correct lang attributes

AB-Labz - Product Experiments Laboratory