Карточка и инструкция

В Мойсклад они называются решениями, так что может встречаться оба варианта названия.

Требования к карточке приложения

1. Видео инструкция, та же, что и на сайте приложения.
2. Несколько снимков экрана с пояснениями.
   1. Разрешение снимков 1280*720.
   2. Размещаются в docs/<app_name>/marketplace/*
   3. Имеют формат .png
3. Подробное текстовое описание возможностей в описании приложения.

Требования к инструкции

Инструкция доступна из карточки приложения в Маркетплейсе решений и в главном интерфейсе приложения.

1. Описание охватывет весь функционал приложения.
   1. Сам файл с инструкцией размещается в docs/<app_name>/user_guide и называется index.md.
2. Большая часть шагов должна сопровождаться скриншотами интерфейса (если у приложения он есть).
   1. Скриншоты для инструкции размещаются docs/<app_name>/user_guide и имеют формат .png.
3. Если у приложения нет своего интерфейса, то необходимо продемонстрировать работу в интерфейсе Мойсклад (на тестовых документах).

Структура инструкции

1. Первая строка это заголовок 1-го уровня вида "Инструкция к решению <имя_приложения>"
2. Общая информация.
   1. С заголовком 2-го уровня "Какие есть функции?" добавить описание всех функций в виде списка.
   2. С заголовком 2-го уровня "Как работает?" добавить Особенности реализации в виде списка.
   3. С заголовком 2-го уровня "Какие есть настройки?" добавить описание для каждой настройки приложения в виде скриншота со списком.
3. Далее идет заголовок 2-го уровня "Функции:".
4. Далее, так же заголовками 2-го уровня, подробное описание работы каждой из функций приложения. Заголовки 3-го уровня не поддерживаются в Мойсклад, поэтому все заголовки только 2-го уровня.

Генерация инструкции

1. Из корня репозитория запустить make docs-gen-guide <app_name>, в случае успешной генерации в консоли не будет ошибок.
2. Готовый к загрузке в Мойсклад архив с инструкцией будет располагаться в docs/build/<app_name>.zip.