Возможности GitHub Wiki

[Astrodynamic]

Необходимо определить необходимость ведения подобной страницы.

В нашем проекте помимо ссылок на документы в облаке, будет набор диаграм которые необходимо каким - то образом визуализировать, поэтому необходимо разобрать вопрос о ведении документации в корне основного проекта, для того чтобы позволить показывать документации с помощью плагинов в vscode.

Также определиться в выборе инструментов демонстрации draw.io или plantuml

[Astrodynamic]

Все страницы и ресурсы, которые планируются размещать на wiki формируются в корневой директории. Зависимости и вложености страниц не на что не влияют.
Если и формировать документацию, то лучше это делать в редакторе.

[Astrodynamic]

Если добавить к коментарию префик #<номер задачи> она определяется и связывает комит с задачей. Это можно увидеть по предыдущему коментарию.

[Astrodynamic]

Предпологается для документации создать wiki, где кратко будет перечислено описание и ссылки на документы. А также объеснения различного рода документов которые будут храниться в корневом котологе основного проекта в директории docs.

[Astrodynamic]

В wiki стартавая страница будет представлена просто содержанием без всяких описаний. В основном readme который как раз и переправляет к wiki будет краткое пояснение, которого как я думаю хватит.

[Astrodynamic]

Замечено, что удобно оставить всё связанное с документацией и не входит в перечень инструментов для автогенерации кода и всёго такого как doxygen, лучше оставить на wiki. Так как для plantuml можно сделать svg представление которое доступно md файлам, а также если и кому будет интересно интерактивное взаимодействие wiki также можно склонировать.

[Astrodynamic]

На стартовую страницу документации добавлено содержание, которое со временем будет одоптированно. На данный момент создано чтобы заполнить шаблон и дать понимание структуре. Также необходимо для взаимосвязи содержаний давать полный внешний url.

[Astrodynamic]

В будующем целесобразно информацию которая кординально отличается выделять в отдельную директорию, а в нутри контекста использовать теги. Для тегов есть внутри wiki внешний список всех тем который целесобразно использовать.

[Astrodynamic]

Для ресурсурсов создать директорию в которой также сделать разделение по темам.