index
Meshtastic documentation is an important ingredient to the overall project. We want users to hit the ground running with the information they need right at their finger tips. This section will discuss the documentation software stack, file organization, and style guides.
Стек программного обеспечения
Вся наша документация хранится на GitHub. Инструкции по настройке аккаунта GitHub находятся here.
Наша документация работает на Docusaurus — платформе для документации, построенной на React и использующей markdown-файлы. Поскольку markdown-файлы легко редактировать, большинство изменений контента должно быть довольно простыми.
Еще один компонент, который мы используем, — Vercel — платформа для фронтенд-фреймворков и статических сайтов. Инструкции по настройке вашего экземпляра Vercel находятся here.
Организация документации
| Раздел | Путь к файлу | Описание |
|---|---|---|
| About Meshtastic | docs/about |
Объяснение Meshtastic на высоком уровне плюс всё, относящееся к mesh-сети Meshtastic. Включает настройки радио, алгоритм mesh и шифрование. |
| Getting Started | docs/getting-started |
Инструкции по установке прошивки Meshtastic на устройство пользователя. |
| Device Settings | docs/settings |
Детали конфигураций устройства и модулей. Описывает каждую настройку пользователя, объясняет их функциональность и направляет пользователя по настройке устройства с помощью различных клиентов (Android, CLI, iOS, Web). |
| Hardware Details | docs/hardware |
Любое содержимое, связанное с оборудованием, такое как официально поддерживаемые радиостанции и их периферия: 3D-печатные корпуса, антенны, кнопки, звуковые сигналы, ротационные энкодеры и экраны. |
| Meshtastic Software | docs/software |
Обзор текущего ПО, используемого совместно с Meshtastic, включая официально поддерживаемые клиенты и приложения сообщества. |
| Contribute to Meshtastic | docs/developers |
Детали необходимой информации для разработчиков, чтобы начать вклад в разработку проекта Meshtastic. |
| Legal | docs/legal |
Любая юридическая информация. Большинство изменений здесь будет обрабатывать разработчики, работающие над проектами, требующими юридических раскрытий. Примеры: торговая марка Meshtastic, условия обслуживания и политика конфиденциальности. |
Быстрый старт
Предполагая, что у вас установлены предварительные требования, запуск локальной инстанции Docusaurus требует трех шагов:
-
Сделайте форк/клонируйте репозиторий meshtastic/meshtastic и перейдите в корневую директорию проекта.
shell title="Clone the project" git clone https://github.com/meshtastic/meshtastic.gitshell title="Clone fork of the project" git clone https://github.com/[username]/meshtastic.gitshell title="Change Directory" cd ~/Meshtastic -
Установите зависимости
shell title="Install dependencies using pnpm" pnpm i -
Запустите Docusaurus
shell title="Run a local documentation server and open it in your browser" pnpm run start
:::tip Перед отправкой pull request полезно запустить следующую команду, чтобы убедиться, что нет битых ссылок или ошибок:
shell title="Build Project"
pnpm run build
:::