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

Question

[ZakkMalin]

На сайте VSCode пишется об "keep current" собственной документации:

В 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.

Кто может понять, что за кул фичу они привели в пример касательно документации с гитом в связке с малти-рут разработкой нескольких проектов одновременно?

Comments

[ZakkMalin]

sim3x, Stalker_RED вы понимаете, как могут быть связаны workspace, документация, и репозиторий 3 в 1?

[ZakkMalin]

Сергей Горностаев седой и строгий, что пытается VSCode сказать в качестве примера?

[rustler2000]

А чего так подписчиков то много? Lost in translation :E

[ZakkMalin]

rustler2000,

А чего так подписчиков то много? Lost in translation :E

Отлично, переведите выделенное жёлтым, интересно услышать вашу версию

[rustler2000]

ZakkMalin "К примеру, вы моглибы иметь репозитарий с документацией по продукту который (реп с докой) вы хотелибы поддерживать актуальным когда вы обновляете код продукта".

[ZakkMalin]

rustler2000, так а я его и так могу поддерживать актуальным что с workspaces что без

[rustler2000]

ZakkMalin, так это твое дело - это просто пример (я к примеру в не монорепах много репов открываю сразу в одном воркспейсе). но полюбому автогенерация доки оттуда ну никак не выводится.

Answer 1

[Igor Deyashkin]

Я это понимаю так:

Под 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.

просто пример, когда это может быть удобно использовать. А именно тут приводится случай, когда у вас есть некий проект с исходным кодом и отдельный проект с документацией к этому коду. Они находятся в разных репозиториях. Но редактировать вы их скорее всего захотите одновременно. И поэтому удобно иметь их сгруппированными в одном воркспейсе. Например, добавили аргумент в функцию - нужно обновить и документацию. Удобно это делать когда все затрагиваемые файлы у вас находятся в одном месте - можно использовать глобальный поиск, например, по всем файлам и внести изменения везде где нужно. О том как эти изменения делать тут речи не идет. Так что этот топик не имеет отношения к автогенерации документации.

Comments

[ZakkMalin]

Они находятся в разных репозиториях

поэтому удобно иметь их всгруппированными в одном воркспейсе

Воркспейсы и репозитории какой-то командой/пунктом главного меню группируются, или это что-то абстрактное?

[Igor Deyashkin]

Я не совсем понял вопрос Что значит абстрактное? Так или иначе попробую переформулировать. Вот у вас открыта какая-то директория в vscode. Вы добавляете туда другую директорию - все, текущий воркспейс стал multiroot, так как в нем несколько директорий верхнего уровня. При этом они могут быть самостоятельными воркспейсами, а могут не быть. Сохраняется конфигурация этого воркспейса через меню (File > Save Workspace As) или соответствующую быструю клавишу.
В общем, multiroot воркспейс - это просто воркспейс, в котором присутствует несколько директорий, при этом каждая из них может как содержать собственные настройки .vscode и/или репозиторий, так и быть обычной директорией.

Я буду скучать по всгруппированным проектам =(

[ZakkMalin]

Igor Deyashkin,

Я буду скучать по всгруппированным проектам =(

Именно так языки и развиваются

Answer 2

[GavriKos]

Да что угодно может быть. Вам никто не мешает в папку проекта положить md-файлы и вести в них доку, например.

Comments

[ZakkMalin]

Да что угодно может быть. Вам никто не мешает в папку проекта положить md-файлы и вести в них доку, например.

А для чего тогда при этом использовать workspaces

Спрашиваю, потому что провёл корреляцию, между успешными проектами, и грамотной документацией к ним, хороший проект и документация уже стали синонимами

[GavriKos]

ZakkMalin, возможно для того, чтобы эта документация была прям в проекте? VSCode умеет редактировать и всячески красиво работать с md

[ZakkMalin]

GavriKos,

VSCode умеет редактировать и всячески красиво работать с md

А как это связано с Git?

[GavriKos]

ZakkMalin, с гитом связано через "забирая исходники - вы сразу забираете документацию".

[ZakkMalin]

GavriKos,

забирая исходники - вы сразу забираете документацию

а бывает не сразу а "чуточку попозже"?

[GavriKos]

ZakkMalin, да, если они в разных репах или не связанных воркспейсах.

[ZakkMalin]

GavriKos, связанные воркспейсы слышу впервые, спасибо это лайк, чтото нововое начинает проясняться, это интересно, тема для нового вопроса