Короче, не могу не поделиться крутым струментом для рисования графиков прям в ридмишках.
Показали вчера на работе, и я чет с этого дела прям проперся. Называется mermaid.
Суть в чем. Пишете вот такое в ридмихе, а при рендере получаете то что показано в пояснительном дикпике 🍆.
stateDiagram
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
🌝 Чем полезно
Мое скромное мнение 🌚 в том, что дока должна лежать как можно ближе к коду. Но есть нюанс. Когда рисуешь диаграмы в миро, к примеру, и прикрепляешь фотку к доке, это работает плохо.
То в миро поправят, а фотку не обновят, то доску грохнут. Короче, может разъехаться что-то.
А тут все в одном месте.
🅰️Итого: Хотите нарисовать схему в вашей доке – используйте mermaid.
PS. Когда я сегодня бегал и размахивал mermaid'ом, говоря, какая это охуенная штука, ко мне подошли и объяснили, что оказывается есть еще одна похожая штука, называется PlantUML. Она примерно про то же, так что у нас теперь есть выбор!