Где лучше разместить документацию к проекту на github?
Ку.
Сгенерировал документацию для проекта в doxygen, хочу закинуть на github pages. Вопрос: как это сделать логичнее и правильнее?
Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё? Или может создать отдельный репозиторий под документацию и на его основе создать страницу?
Ответы (1 шт):
Автор решения: Vladislav Moshikov
→ Ссылка
Документация относящаяся к проекту - должна находиться в одном репозитории.
Вы можете воспользоваться общепринятой практикой назвать дирректорию docs и разместить в ней сгенерированные файлы. В этой дирректории могут также находиться UML диаграммы и HTTP запросы.
При этом описание проекта следует разместить в файле README.md в корне репозитория