README справочного центра

Добро пожаловать в справочный центр DSE. Эта тема объясняет, как устроена встроенная система справки на Markdown и как добавлять/обновлять переведённые файлы справки.

Что это за система справки

DSE загружает темы справки из файлов Markdown в папке Help, расположенной рядом с приложением. У каждого языка своя папка, а имя файла темы одинаковое для всех языков.

• Пример папки: Help/ru
• Пример файла темы: help.quickstart.md

Поддерживаемые языковые папки (текущий проект)

• en — английский
• es — испанский
• fr — французский
• ru — русский
• ar — арабский
• zh-Hans — китайский (упрощённый)

Поведение резервного выбора (fallback)

Если для текущего языка интерфейса нет точного файла, DSE пробует:

1. Точную папку культуры (например, fr-CA, если она есть)
2. Папку двухбуквенного языка (fr)
3. Английский (en)

Как добавить или обновить тему

1. Сначала создайте/обновите английский файл (например, Help/en/help.readme.md)
2. Добавьте файл с тем же именем в другие языковые папки
3. Переведите текст, сохраняя ту же структуру Markdown
4. Если это новая видимая тема, добавьте её ID в HelpCenterViewModel._topicIds
5. Пересоберите приложение и проверьте справочный центр

Рекомендации по оформлению

• Начинайте с заголовка # (он используется как название темы в списке)
• Делайте разделы короткими и практичными
• Используйте маркированные списки для шагов
• Используйте стабильные имена и пути, чтобы переводы оставались синхронными

Подсказка

Папку справки можно открыть прямо из окна Help Center кнопкой Open Folder, затем изменить Markdown-файлы и пересобрать приложение.