Review documentation for completeness and clarity

[RichardBruskiewich]

Project documentation needs refinement:

• Develop and deploy full mkdocs structured documentation hosted on Github.io (or readTheDocs)
• Specific topics to review:
  • End user documentation of the semantics of the SRI Test harness unit tests and the test validation message codes
    • Maybe one or two hash indexed HTML or Markdown data dictionaries in the appropriate code repositories
    • Can this documentation be autogenerated from embedded as code comments and/or in code definition files
  • Translator resource owner guidance on configuration of KP test data or ARA configuration JSON test data
  • Running Docker (Compose)
  • Configuring use of MongoDb versus File based capture of test runs
  • General developer docs:
    • Overview of the system design
      • Relationship with Translator SmartAPI Registry
      • Pytest Engine
      • Validation logic: relationship with TRAPI and Biolink (reasoner-validator) module
      • Validation reports
      • Web Service API
      • Web Dashboard
    • Extending the system (i.e. with new knowledge graph semantic unit tests)