Skip to content

Improve user facing docs

Martin Blanchard requested to merge mablanch/51-user-facing-docs into master

Description

Initial user documentation effort. Main sections:

  • About: sourced for README.
  • Installation: installation instructions.
  • Using: example with usage instructions.
  • Reference: CLI and API reference.
  • Contributing: sourced for CONTRIBUTING.

Changes proposed in this merge request:

  • Turn existing instructions into documentation pages.
  • Update the installation instructions
  • Update the contribution instruction
  • Generate CLI reference.
  • Generate API reference.

This merge request, when approved, will close issue/bug:

Edited by Martin Blanchard

Merge request reports