Исправление документации

PR с исправлениями приветствуются. Исправляйте опечатки, неработающие ссылки, устаревшие примеры, непонятные объяснения и переводы. Для исправления, затрагивающего только документацию, не требуется ни issue, ни неуспешный тест кода.

Локальный предпросмотр

Создайте форк wailsapp/wails, клонируйте его и создайте ветку от master.

Установите зафиксированную версию генератора документации:

go install github.com/leaanthony/mpress/cmd/mpress@v1.0.17

Вы также можете скачать проверенный исполняемый файл из
выпуска M-Press v1.0.17.

Из корневого каталога репозитория Wails:

mpress version
mpress dev

Редактируйте исходные файлы .md в docs/mpress/content/. Английский язык используется по умолчанию, и его файлы находятся непосредственно в этом каталоге. Существующие переводы находятся в языковых каталогах, например fr/ и id/. Предпросмотр обновляется при сохранении изменений.

Сохраняйте блок метаданных в начале каждой страницы и парные компоненты @... / @end. Обычные абзацы, заголовки, списки и блоки кода с ограждением можно редактировать как текст. Не редактируйте сгенерированные файлы в docs/mpress/site/.

Проверка исправления

python3 docs/mpress/scripts/check_translations.py
mpress build --strict --no-purge-css
mpress check
# Use `python` on Windows if `python3` is unavailable.
python3 docs/mpress/scripts/check_site.py docs/mpress/site

Проверьте изменённую страницу в браузере и запустите все изменённые вами примеры кода. При исправлении перевода сравните весь изменённый фрагмент с английским оригиналом. Не изменяйте команды, имена API, ссылки, примеры кода и связи на диаграммах. Используйте естественный технический язык, сохраняйте требования и оговорки и переводите не только основной текст, но и видимые подписи на диаграммах, элементы навигации и описания изображений.

Для каждого опубликованного языка должен существовать полный перевод каждой англоязычной страницы. Не используйте английские заполнители или резервные страницы. При исправлении одного перевода можно изменить только этот язык. Если вы меняете смысл английского текста, обновите соответствующие страницы на остальных опубликованных языках; повторно создавать не связанные с изменением страницы не требуется.

Отправка pull request

Откройте PR в master. Опишите, что было неверно, объясните своё исправление и перечислите выполненные проверки. Для заметных изменений макета приложите снимки экрана, а для изменённых примеров кода укажите платформу и версию.

Учётные данные Cloudflare и закрытые сервисы не требуются. Общедоступные проверки PR собирают и проверяют статический сайт без учётных данных для развёртывания.

Сведения об изменениях кода и предложениях новых функций см. в разделе «Участие в разработке Wails». Сведения о внутреннем устройстве см. в разделе «Технический обзор».