publish

Опубликовать в продакшене

1. Сгенерировать документацию protobuf

shell cd meshtastic ./scripts/gen-proto-docs.sh

1. Собрать

shell pnpm build

1. Отправить Pull Request

Публикация в Vercel

Настройка аккаунта Vercel — это необязательный шаг, который поможет вам просматривать изменения в документации в серверной среде, аналогичной реальным документациям. Это полезно включать при отправке pull request, чтобы разработчики могли просмотреть ваши изменения и визуально проверить, что всё выглядит правильно.

Настройка аккаунта Vercel

• Перейдите на vercel.com
• Войдите с помощью аккаунта GitHub, нажмите Continue with GitHub

Подключить ваш форк проекта

• Нажмите New Project
• В разделе Import Git Repository выберите + Add GitHub Account Вас перенаправит на GitHub для разрешения доступа к выбору репозиториев.
• Выберите ваш форк проекта: username/Meshtastic

Настройка проекта

Настройте проект:

• Установите имя для проекта
• Выберите пресет фреймворка: Docusaurus 2
• Нажмите Deploy

Всё! Теперь вы должны увидеть свой проект с зелёной или оранжевой точкой статуса, показывающей, что ваш форк проекта скомпилирован. Будет URL, специфичный для коммита, которым можно поделиться для просмотра изменений. Также будет URL, специфичный для ветки, который можно просмотреть. Если возникнут ошибки, статус станет красным и включит логи, чтобы вы могли разобраться, что пошло не так.

:::tip Количество URL веток, которые вы сможете просматривать, ограничено. Если вы заметите, что эта опция исчезла, удалите неиспользуемые ветки в вашем форке — это снова включит эту функцию.

URL веток полезны в PR, поскольку они остаются постоянными, и вам не придётся предоставлять новый URL для ревью при каждом новом коммите, если запросят изменения. :::