Дискуссия о документации, работа над DX

[iwwwanow]

предложения:

1. добавить в документацию примеры команд
2. вынести флаги и что они делают на уровень документации
3. добавить флаг -u (url) для генерации темы и ассетов. сейчас нужно из search-params выдергивать значения. какое за что отвечает - непонятно
4. добавить кликабельный figma-макет. непонятно, как долджен выглядить компонент, какая у него должна быть вложенность. можно в макет, рядом, поместить "частые ошибки"
5. сейчас есть 2 документации в проекте. одна в README в руте, втора я в ВИКИ.
   • документация в вики самая актуальная. её можно разделить на несколько страниц:
     1. подготовка окружения, подготовка токена фигма
     2. генерация темы
     3. генерация фрагментов
6. есть 2 варианта генерации - --method=secondary. нужен ли нам primary? насколько понимаю, он как устаревший, по старым шаблонам генерирует
7. нужно ссылаться на этот пакет. или указать его в доке. это логическое продолжение сего действа - https://github.com/atls/hyperion/blob/26f35841f49fd52c671e2dd49633d6ee71494995/generators/appearance/package.json#L8

[iwwwanow]

@TorinAsakura @Amiditin @Nelfimov fyi

[TorinAsakura]

Это проект структуры, который я делал несколько лет назад для клиентов и их дизов https://www.figma.com/design/MvWb7thyRqKetgvN79Pxjh/Structure?node-id=0-1&p=f&t=vqSsdTlPUsqLiMTF-0 - его вполне можно дотьюнить до нужного состояния и передавать в качестве примера

[TorinAsakura]

• есть 2 варианта генерации - --method=secondary. нужен ли нам primary? насколько понимаю, он как устаревший, по старым шаблонам генерирует

не нужен

[TorinAsakura]

С остальным согласен

[iwwwanow]

дискуссию закрываю, разбил на 2 задачи:

• Рефактор генератора #61
• Рефактор документации #60