Как поддерживать базу актуальной

Как предложить перевод, практическую заметку или исправление в Orca Guide и какие сведения нужны для проверки публикации.

Orca Guide не связан с командой Orca и не заменяет официальную документацию. Проект переводит материалы на русский язык и принимает проверенные заметки сообщества.

Перед началом

Проверьте, нет ли уже задачи с тем же предложением. Для небольшого исправления достаточно указать URL, неверный фрагмент и подтверждающий источник. Для новой статьи заранее опишите аудиторию, решаемую задачу и способ проверки.

Как переводить страницу

Откройте нужный файл в content/docs.
Переводите текст небольшими смысловыми частями.
Если поведение Orca изменилось, сверяйтесь с официальной документацией и добавляйте дату проверки.
Не удаляйте ссылку на первоисточник и сведения о независимом статусе базы.
Запустите npm run types:check и npm run build.

Как добавлять практическую заметку

Создайте новый .mdx-файл в content/docs/community, внесите его в meta.json и укажите, на какой версии Orca проверен рецепт. Это отделяет проверенный пользовательский опыт от перевода официального текста.

Официальные документы и названия продуктов принадлежат своим владельцам.

Что должно быть в практической заметке

задача и ожидаемый результат;
версия Orca, операционная система и применимые ограничения;
воспроизводимые шаги без секретов и приватных данных;
способ проверить результат;
типичные ошибки и безопасный способ отмены изменения;
ссылки на связанные статьи базы.

Как сообщить об ошибке

Создайте GitHub Issue и приложите ссылку на страницу. Не публикуйте токены, файлы cookie, содержимое .env, приватные адреса серверов и код закрытого проекта.

Правила проверки источников и порядок исправлений описаны в редакционной политике. Сведения о проекте и контактах доступны на странице «О проекте».

Частые вопросы

Как проще всего сообщить об ошибке?

Создайте GitHub Issue и укажите точный URL, ошибочный фрагмент, правильный вариант и источник для проверки.

Можно ли предложить новую практическую заметку?

Да. Опишите задачу, окружение, последовательность действий и способ убедиться, что результат работает.

Какие сведения нужны для воспроизведения проблемы?

Полезны версия Orca, операционная система, используемый агент, ожидаемое и фактическое поведение.

Что нельзя публиковать в открытом обращении?

Не добавляйте ключи API, токены, закрытый исходный код и персональные данные.

Нужно ли заранее идеально оформлять текст?

Нет. Важнее точность и проверяемые сведения, а редакция поможет привести формулировку к стилю документации.