Documentation separate from main repository?

All discussion on project related documentation including source docs, manuals, and tutorials go here.
Post Reply
Lamoot
Posts: 118
Joined: 22 Apr 2016, 12:03

Documentation separate from main repository?

Post by Lamoot » 02 Jan 2021, 19:42

Documentation for OpenMW is currently a part the project's main repository. To prevent inflating repository's size with images, a separate repository https://gitlab.com/OpenMW/openmw-docs is used to contain the image files.

To me it makes sense everything for documentation is in a single place. Would it be possible to move the doc files from openmw to openmw-docs or are there some other constraints not to do it?

User avatar
AnyOldName3
Posts: 2023
Joined: 26 Nov 2015, 03:25

Re: Documentation separate from main repository?

Post by AnyOldName3 » 03 Jan 2021, 01:49

Settings documentation living in the same repo as the things the settings affect makes sense.
AnyOldName3, Master of Shadows

Lamoot
Posts: 118
Joined: 22 Apr 2016, 12:03

Re: Documentation separate from main repository?

Post by Lamoot » 03 Jan 2021, 16:58

By keeping things as they are, we are still left with documentation split between two repositories - text in openmw and images in openmw-docs. The process of submitting a single part of user documentation is then split between two MR's in two separate repositories. This is an unnecessary nuisance for anyone who wants to work on documentation with any amount of images involved.

If we look at other successful open source projects - Blender, Godot and Krita all have user documentation separate from the main project and their manuals include a lot of images.

Post Reply