feat(changelog): add support for changelog blocks #226
Conversation
| } | ||
| } | ||
|
|
||
| tokens.splice(openAt, closeAt + 1 - openAt); |
There was a problem hiding this comment.
Я не уверен, что в RFC имелось в виду такое поведение.
Думаю ожидаемый результат, что ченжлог порендерится в виде обычного md документа и вырежутся конструкции {% changelog %} и {% endchangelog %}
Ты же вырезаешь конструкции вместе с контентом.
There was a problem hiding this comment.
нет, наоборот, эти секции не должны быть видны в доке. Это как бы сниппеты, которые показываются на сайте, а полная дока тут
There was a problem hiding this comment.
Погоди, мне казалось юзкейс такой:
На сайте есть попап в котором отображаются три последних изменения.
И ссылка "Все изменения можно посмотреть тут". По клику переходим на страницу документации.
И на этой странице полный ченжлог.
При этом что на сайте, что на полной странице, описание любого изменения это короткий текс + картинка.
There was a problem hiding this comment.
Нет, блоками обозначаем сниппеты которые будут на сайте, а в доке полный чейндж лог, да, но он отличный от сниппетов. А вместе оно для консистентности и удобства их вести. А еще страницу можно будет дополнять, добавляя еще новые сниппеты
There was a problem hiding this comment.
Тогда я не понимаю зачем внутри ченжлога используется md разметка.
Можно все поместить в метаинформацию.
There was a problem hiding this comment.
Ну можно вставлять ссылки, форматировать текст итп
| env.changelogs = []; | ||
| } | ||
|
|
||
| env.changelogs.push(change); |
There was a problem hiding this comment.
Не уверен что так заработает.
Как пример возьмем документацию Облака.
Она состоит из кучи проектов. И каждый захочет иметь собственный ченжлог.
Нужно либо добавлять обязательное поле в мета информацию, либо сплитить ченжлоги по имени файла.
There was a problem hiding this comment.
ненене, мы складываем json рядом, вот тут diplodoc-platform/cli#348 и там все аккуратно оно харнится
Feverqwe
changed the title
Feverqwe
force-pushed
the
rndnm/UXRFC-31/changelogs
branch
from
9a8108e to
1c3ac59
Compare
No description provided.