Split docs into their own repo?

[wolfspyre]

Is your feature request related to a problem? Please describe.

With the codebase as it is, documentation and the OI code reside in the same repo.

It might make things more maintainable for the long term if the documentation was in its' own repo.

it might not.

I figured opening an issue to discuss the idea seemed prudent.

Describe the solution you'd like

In my opinion, having the docs in its' own repo may lower the barrier to making documentation changes/updates/fixes; as they can be updated in isolation.

This is a pattern followed by a fair bit of ships/projects.... (course, that in and of itself doesn't mean much)

Describe alternatives you've considered

Religiously using labels for different contexts may be just as helpful reasonable alternative.¯_(ツ)_/¯

There's many ways to make it easier to find/assess things. and this is just an opinion ;)

Additional context

There are a few downsides to splitting the docs out...

• You lose the ability to relate code-change and documentation-change. This is arguably a good enough reason in and of itself to not do this. The documentation freshness is a vital metric of code health in general; and the only thing worse than no docs, is BAD docs...

• Extra maintenance burden on devs to manage multiple repos wrt tagging/pushes/versions/etc.

• Probably other reasons....