Ongoing Translator Technical Documentation Content Review

[RichardBruskiewich]

Coordinate community review of current content of documentation to identify gaps and actionable requests for editing:

• Publication site maintenance : port readthedocs->Git docs? XREF's between docs and main site? Create automatic Git Action to update?
  • Move documentation from readthedocs to git hub pages #23
  • add link from the readthedocs site to this documentation github repo #32
    Possible Assignees: Richard Bruskiewich, Vincent Emonet
• Review of Landing Pages: completeness, accuracy, ease of navigation and understanding; site License
  • About page - remove Translator components and team names #27
  • Clarify Documentation Site & Project License policies #40
  • Check Translator Developers Documentation for Accuracy #24
    Possible Assignees: Kara Fecho, Nomi Harris
• Systems Design Documentation: architecture and design overview page(s)
  • Fill out "Systems Design" component of the documentation #7
  • Possible Assignees: Tim Putnam, Chris Bizon
• Component team pages: review and update task: ARS plus every ARA and KP
  • Update and refine documentation about ARS design and usage #9
  • Introduction, for new developers, to Translator KP and ARA design concepts and related SRI implementation tools  #11
  • Provide a consistent structure for requested information for ARAs and KPs #39
  • KP page - ask teams to add their KP information #28
  • Check Translator Developers Documentation for Accuracy #24
  • A related issue Service Provider documentation #44 is created for follow up by the Biothings team.
    Possible Assignees: Mark Williams; KP and ARA team representatives
• SRI standards: Biolink, EPC, ReasonerAPI, Workflows
  • Enhance documentation for developers relating to EPC standards #15
  • Compose overview for developers totally new to TRAPI cross-linked to available resources #10
    Possible Assignees: Sierra Moxon, Matt Brush, Eric Deutsch, David Koslicki
• User Interface:
  • Developer introduction and links to Translator User Interface documentation #13
  • Possible Assignees: Andy Crouse
• Tutorials development: Jupyter Notebook, video, ??
  • Link to a rendered version of the “Hello Translator” Jupyter Notebook #34
    Possible Assignees: Chris Bizon