ZakkMalin
@ZakkMalin
Designer

Как репозиторий может быть связан с документацией проекта?

На сайте VSCode пишется об "keep current" собственной документации:
5d128905f1f2b913237994.png
В VSCode есть дескать какието плагины или способы из коробки для автогенерации документации к коду, или не правильно понимаю суть тизера?

P.S. Еслибы это было несколько примеров, то писалось бы что "or" без 's, а не как тут with:
For example, you might have a repository with a product's documentation which you like to keep current when you update the product source code.


Кто может понять, что за кул фичу они привели в пример касательно документации с гитом в связке с малти-рут разработкой нескольких проектов одновременно?
  • Вопрос задан
  • 927 просмотров
Решения вопроса 1
Lobotomist
@Lobotomist
Software Developer
Я это понимаю так:

Под multiroot воркспейсом подразумевается просто-напросто воркспейс, в котором сгруппировано несколько отдельных проектов, каждый может иметь свои настройки в подпапке .vscode. А вот это:

This can be very helpful when you are working on several related projects at one time. For example, you might have a repository with a product's documentation which you like to keep current when you update the product source code.


просто пример, когда это может быть удобно использовать. А именно тут приводится случай, когда у вас есть некий проект с исходным кодом и отдельный проект с документацией к этому коду. Они находятся в разных репозиториях. Но редактировать вы их скорее всего захотите одновременно. И поэтому удобно иметь их сгруппированными в одном воркспейсе. Например, добавили аргумент в функцию - нужно обновить и документацию. Удобно это делать когда все затрагиваемые файлы у вас находятся в одном месте - можно использовать глобальный поиск, например, по всем файлам и внести изменения везде где нужно. О том как эти изменения делать тут речи не идет. Так что этот топик не имеет отношения к автогенерации документации.
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
GavriKos
@GavriKos
Да что угодно может быть. Вам никто не мешает в папку проекта положить md-файлы и вести в них доку, например.
Ответ написан
saboteur_kiev
@saboteur_kiev
build engineer
Это может быть что угодно.
Вплоть до обычных user guide, admin guide в PDF, которые пакуются и поставляются вместе с программой, и которые обновляются с ней.
При этом это разные репозитории, чтобы technical writer не качал лишние исходники, а девелоперы не качали лишние PDF-ы, но зато они связаны, и вы всегда получите соответствующую версию документации.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы
ProfitClicks Краснодар
от 100 000 руб.
от 120 000 руб.
СИБИНТЕК Москва
от 150 000 до 200 000 руб.
18 июл. 2019, в 11:59
20 руб./за проект
18 июл. 2019, в 11:57
13000 руб./за проект
18 июл. 2019, в 11:57
1500 руб./за проект