t10d/kingdom-python-server

Set-up documentation environment

Opened this issue · 0 comments

ruiconti commented

Issue

For proper distribution and adherence, it's vital that we expose a clear, objective but also thorough documentation.

Proposed solution

Possible frameworks:

  • mkdocs: simpler, markdown-based
  • sphinx: idiomatic, thorough, complete

For this initial step, we should consider:

  • Document philosophy and general concept understanding
  • Proper instructions on how to use
  • Proper instructions on how abstractions should be used

This task is somewhat blocked by #9 as instructions derive from that.