Outline Documentation Strategy

[def-mycroft]

I'd like to suggest that the documentation be considered early in this project.

In my experience, it is best to think of documentation as part of the code, i.e. the code isn't really written until some sort of supporting documentation has been created or updated.

Its important for users as well as for contributors, the better the code is documented the easier it is for contributors to contribute to enhancements and bugfixes.

[def-mycroft]

Also @Graeme22 , what do you think about documentation? Is there a certain tool that we want to use?

I've used Sphinx briefly.

[Graeme22]

Sphinx is great. I may have a go at setting up CI down the road as well, which could add some documentation requirements.

In general, I'd look to postpone pull requests without adequate documentation until we can get some rules based mechanism running.