Z
Z
ZakkMalin2019-06-25 23:55:12
git
ZakkMalin, 2019-06-25 23:55:12

How can a repository be linked to a project's documentation?

The VSCode website writes about the "keep current" of its own documentation:
5d128905f1f2b913237994.png
Does VSCode have some plugins or out-of-the-box methods for auto-generating documentation for the code, or do I misunderstand the essence of the teaser?
PS If it were a few examples, then it would be written that "or" without 's, and not like with 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.

Who can understand what kind of cool feature they cited as an example regarding documentation with git in conjunction with multi-root development of several projects at the same time?

Answer the question

In order to leave comments, you need to log in

2 answer(s)
I
Igor Deyashkin, 2019-06-27
@ZakkMalin

I understand it like this:
A multiroot workspace simply means a workspace in which several separate projects are grouped, each can have its own settings in the .vscode subfolder. But this:
just an example of when it might be handy to use. Namely, here is the case when you have a certain project with source code and a separate project with documentation for this code. They are in different repositories. But you will most likely want to edit them at the same time. And that's why it's convenient to have them grouped in one workspace. For example, if we added an argument to a function, we need to update the documentation as well. It is convenient to do this when all the affected files are in one place - you can use a global search, for example, for all files and make changes wherever necessary. How to make these changes is out of the question here. So this topic has nothing to do with documentation auto-generation.

G
GavriKos, 2019-06-26
@GavriKos

Yes, anything can be. Nobody bothers you to put md-files in the project folder and keep the dock in them, for example.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question